Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add quickstart colab notebooks #78

Merged
merged 4 commits into from
May 16, 2024
Merged

chore: add quickstart colab notebooks #78

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe6b299
chore: add notebooks
eloy-encord May 14, 2024
09ff964
chore: embed notebook urls in readme
eloy-encord May 14, 2024
9b81cb7
chore: add CLI quickstart to the banner
eloy-encord May 16, 2024
93150ce
misc: reorder items in the banner to match intention
eloy-encord May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 23 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
<div align="center" style="display: flex; justify-content: space-between;">
<div style="flex: 1; padding: 10px;">
<a href="https://github.com/encord-team/text-to-image-eval/actions?query=workflow%3ATests" target="_blank" style="text-decoration:none"><img src="https://github.com/encord-team/text-to-image-eval/actions/workflows/tests.yml/badge.svg?branch=main"></a>
<a href="https://colab.research.google.com/github/encord-team/text-to-image-eval/blob/main/notebooks/tti_eval_CLI_Quickstart.ipynb" target="_blank" style="text-decoration:none"><img alt="CLI Quickstart In Colab" src="https://img.shields.io/badge/Try_It_In_Colab-blue?logo=googlecolab&labelColor=555"></a>
<a href="https://www.python.org/downloads/release/python-3119/" target="_blank" style="text-decoration:none"><img src="https://img.shields.io/badge/python-3.11%2B-blue" alt="Python Versions"></a>
<a target="_blank" style="text-decoration:none"><img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-Welcome-blue"></a>
<img alt="License" src="https://img.shields.io/github/license/encord-team/text-to-image-eval">
<a href="https://github.com/encord-team/text-to-image-eval/actions?query=workflow%3ATests" target="_blank" style="text-decoration:none"><img src="https://github.com/encord-team/text-to-image-eval/actions/workflows/tests.yml/badge.svg?branch=main"></a>
<a target="_blank" style="text-decoration:none"><img alt="PRs Welcome" src="https://img.shields.io/badge/PRs-Welcome-blue"></a>
</div>
<div style="flex: 1; padding: 10px;">
<a href="https://github.com/encord-team/encord-notebooks" target="_blank" style="text-decoration:none"><img alt="Encord Notebooks" src="https://img.shields.io/badge/Encord_Notebooks-blue?logo=github&label=&labelColor=181717"></a>
Expand Down Expand Up @@ -59,7 +60,11 @@ You can easily benchmark different models and datasets against each other. Here
export ENCORD_SSH_KEY_PATH=<path_to_the_encord_ssh_key_file>
```

## CLI Usage
## CLI Quickstart

<a href="https://colab.research.google.com/github/encord-team/text-to-image-eval/blob/main/notebooks/tti_eval_CLI_Quickstart.ipynb" target="_blank" style="text-decoration:none">
eloy-encord marked this conversation as resolved.
Show resolved Hide resolved
<img alt="CLI Quickstart In Colab" src="https://img.shields.io/badge/Try_It_In_Colab-blue?logo=googlecolab&labelColor=555">
</a>

### Embeddings Generation

Expand Down Expand Up @@ -103,6 +108,13 @@ To interactively explore the animation in a temporary session, use the `--intera
<img width="600" src="https://storage.googleapis.com/docs-media.encord.com/static/img/text-to-image-eval/embeddings.gif">
</div>

> ℹ️ You can also carry out these operations using Python. Explore our Python Quickstart guide for more details.
>
> <a href="https://colab.research.google.com/github/encord-team/text-to-image-eval/blob/main/notebooks/tti_eval_Python_Quickstart.ipynb" target="_blank" style="text-decoration:none">
> <img alt="Python Quickstart In Colab" src="https://img.shields.io/badge/Python_Quickstart_In_Colab-blue?logo=googlecolab&labelColor=555">
> </a>


## Some Example Results

One example of where this `tti-eval` is useful is to test different open-source models against different open-source datasets within a specific domain.
Expand Down Expand Up @@ -185,6 +197,10 @@ The models are evaluated against four different medical datasets. Note, Further

## Datasets

<a href="https://colab.research.google.com/github/encord-team/text-to-image-eval/blob/main/notebooks/tti_eval_Bring_Your_Own_Dataset_From_Encord_Quickstart.ipynb" target="_blank" style="text-decoration:none">
<img alt="Datasets Quickstart In Colab" src="https://img.shields.io/badge/Quickstart_In_Colab-blue?logo=googlecolab&labelColor=555">
</a>

This repository contains classification datasets sourced from [Hugging Face](https://huggingface.co/datasets) and [Encord](https://app.encord.com/projects).

> ⚠️ Currently, only image and image groups datasets are supported, with potential for future expansion to include video datasets.
Expand Down Expand Up @@ -258,6 +274,10 @@ However, all embeddings previously built on that dataset will remain intact and

## Models

<a href="https://colab.research.google.com/github/encord-team/text-to-image-eval/blob/main/notebooks/tti_eval_Bring_Your_Own_Model_From_Hugging_Face_Quickstart.ipynb" target="_blank" style="text-decoration:none">
<img alt="Models Quickstart In Colab" src="https://img.shields.io/badge/Quickstart_In_Colab-blue?logo=googlecolab&labelColor=555">
</a>

This repository contains models sourced from [Hugging Face](https://huggingface.co/models), [OpenCLIP](https://github.com/mlfoundations/open_clip) and local implementations based on OpenCLIP models.

_TODO_: Some more prose about what's the difference between implementations.
Expand Down
Loading
Loading