Skip to content

Commit 09ff964

Browse files
committed
chore: embed notebook urls in readme
1 parent fe6b299 commit 09ff964

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,11 @@ You can easily benchmark different models and datasets against each other. Here
5959
export ENCORD_SSH_KEY_PATH=<path_to_the_encord_ssh_key_file>
6060
```
6161

62-
## CLI Usage
62+
## CLI Quickstart
63+
64+
<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">
65+
<img alt="CLI Quickstart In Colab" src="https://img.shields.io/badge/Try_It_In_Colab-blue?logo=googlecolab&labelColor=555">
66+
</a>
6367

6468
### Embeddings Generation
6569

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

110+
> ℹ️ You can also carry out these operations using Python. Explore our Python Quickstart guide for more details.
111+
>
112+
> <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">
113+
> <img alt="Python Quickstart In Colab" src="https://img.shields.io/badge/Python_Quickstart_In_Colab-blue?logo=googlecolab&labelColor=555">
114+
> </a>
115+
116+
106117
## Some Example Results
107118

108119
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.
@@ -185,6 +196,10 @@ The models are evaluated against four different medical datasets. Note, Further
185196

186197
## Datasets
187198

199+
<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">
200+
<img alt="Datasets Quickstart In Colab" src="https://img.shields.io/badge/Quickstart_In_Colab-blue?logo=googlecolab&labelColor=555">
201+
</a>
202+
188203
This repository contains classification datasets sourced from [Hugging Face](https://huggingface.co/datasets) and [Encord](https://app.encord.com/projects).
189204

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

259274
## Models
260275

276+
<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">
277+
<img alt="Models Quickstart In Colab" src="https://img.shields.io/badge/Quickstart_In_Colab-blue?logo=googlecolab&labelColor=555">
278+
</a>
279+
261280
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.
262281

263282
_TODO_: Some more prose about what's the difference between implementations.

0 commit comments

Comments
 (0)