Update README.md

README.md

@@ -12,14 +12,16 @@ tags:
 [![arXiv](https://img.shields.io/badge/arXiv-1234.56789-b31b1b.svg)](https://arxiv.org/abs/2311.14517)
 
 This repository contains the official implementation of [tinyCLAP](https://arxiv.org/abs/2311.14517).
+To access the project website, using [this link](https://francescopaissan.it/tinyclapweb/).
 
 ![tinyCLAP overview](https://francescopaissan.it/tinyclapweb/assets/overview.png)
 
 ## Requirements
 
-To install requirements:
+To clone the repo and install requirements:
 
 ```setup
+git clone https://github.com/fpaissan/tinyCLAP & cd tinyCLAP
 pip install -r extra_requirements.txt
 ```
 
@@ -65,9 +67,23 @@ python train_clap.py --experiment_name tinyCLAP_$MODEL_NAME --zs_eval True --tut
 
 ## Pre-trained Models
 
-You can download pretrained models here:
+You can download pretrained models from the [tinyCLAP HF](https://huggingface.co/fpaissan/tinyCLAP).
 
-- [My awesome model](https://drive.google.com/mymodel.pth) trained on ImageNet using parameters x,y,z.
+_Note_:  The checkpoints on HF contain the entire CLAP module (complete of text encoder and teacher encoder).
+
+To run inference using the pretrained models, please use:
+
+```bash
+python train_clap.py --pretrained_clap fpaissan/tinyCLAP/$MODEL_NAME --zs_eval True --tut17_folder $PATH_TO_TUT17
+```
+
+This command will automatically download the checkpoint, if present in the zoo of pretrained models. Make sure to change the dataset configuration file based on the evaluation.
+
+A list of available models with their computational cost is described in the follwing table:
+
+| alpha | beta | t0 | N | Params [M] | ESC-50 | UrbanSound8K | TUT17 |
+|:-----:|:----:|:--:|:-:|:----------:|:------:|:------------:|:-----:|
+|  1.5  | 0.75 |  6 | 7 |     4.4    |      |          |   |
 
 ## Citing tinyCLAP