Skip to content

Commit

Permalink
docs: link to the model checkpoints part
Browse files Browse the repository at this point in the history
  • Loading branch information
amitkparekh committed Jul 4, 2024
1 parent 4132e35 commit a117cc1
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ Amit Parekh, Nikolas Vitsakis, Alessandro Suglia, and Ioannis Konstas.
pdm run python src/cogelot/entrypoints/train.py --experiment=01_their_vima
```

5. Evaluate a model
5. Evaluate a model from one of the [provided checkpoints](#model-architectures-and-checkpoints)

```bash
pdm run python src/cogelot/entrypoints/evaluate.py trainer.devices=1 model.model.wandb_run_id=8lkml12g
Expand All @@ -69,6 +69,7 @@ Amit Parekh, Nikolas Vitsakis, Alessandro Suglia, and Ioannis Konstas.
- [Evaluation Framework Overview](#our-evaluation-framework)
- [What is included in this project?](#what-is-included)
- [Model Architectures and Provided Checkpoints](#model-architectures-and-checkpoints)
- [How I ran things](#how-i-ran-things)
- [Install dependencies](#how-i-managed-and-installed-dependencies)
- [Easily check that everything works](#how-i-checked-that-everything-worked-before-i-ran-things)
Expand Down Expand Up @@ -107,9 +108,11 @@ Additionally, I've tried to work in a constrained, clean, and robust manner. I h

### Model Architectures and Checkpoints

All model checkpoints are stored on Hugging Face, but *they will not work with the Transformers library out-of-the-box*. This library contains multiple methods and functions to make the checkpoints work on our framework, but it's all included for you.
Below is a table of each model run and where to find the checkpoints. We're providing all checkpoints from the end of each epoch, even though we only used the one from the very last epoch.
**You do not need to download checkpoints yourself.** This library contains multiple methods and functions to make the checkpoints work on our framework, and it's all included for you. All model checkpoints are stored on Hugging Face, but *they will not work with the Transformers library out-of-the-box*.


Below is a table of each model run and where to find the checkpoints. We're providing the checkpoint stored at the end of each training epoch. I detail how I ran things in a later section.


| Instruction-style | Instruction Modalities | Prompt-conditioning | Vision Encoder | Shuffled Objects? | Model ID | Experiment ID |
Expand Down

0 comments on commit a117cc1

Please sign in to comment.