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.

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

Ckpt docs #61

Merged
merged 14 commits into from
Nov 27, 2024
Merged

Ckpt docs #61

merged 14 commits into from
Nov 27, 2024

Conversation

pgarrison
Copy link
Collaborator

@pgarrison pgarrison commented Nov 26, 2024

Issue

We need to explain how to download and use the checkpoints.

Closes #6

Changes

  • Write a table describing how to copy checkpoints to folders like configs/experiment/cellpack/ckpts.
  • For completeness, replace the single example of run_embeddings.py with a table of all 6 options.
  • Some other miscellaneous clean up, partially because of pre-commit

Reviewing

  • See new docs here
  • @ritvikvasan Will the models actually read checkpoints from configs/experiment/cellpack/ckpts without further changes? I know that's where the checkpoints are output, but I don't know if they read from there too.
  • If we like this thorough "table of commands" format I can do it for the benchmarking analysis steps too (separate PR).

@pgarrison pgarrison marked this pull request as ready for review November 26, 2024 21:23
@ritvikvasan
Copy link
Collaborator

the checkpoints don't have to be copied there. We just need to refer to wherever it was saved in the results config under model_checkpoints here - https://github.com/AllenCell/benchmarking_representations/blob/main/configs/results/cellpack.yaml

@ritvikvasan
Copy link
Collaborator

maybe we can update the to this folder section in your table, with the corresponding result config?


## Steps to run benchmarking analysis

1. To compute benchmarking features from the embeddings and trained models, run

```
```bash
python src/br/analysis/run_features.py --save_path "/outputs_cellpack/" --embeddings_path "./morphology_appropriate_representation_learning/model_embeddings/cellpack" --sdf False --dataset_name "cellpack" --debug False
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can make a similar matrix/table for both run_features and run_analysis

docs/USAGE.md Outdated Show resolved Hide resolved
@pgarrison
Copy link
Collaborator Author

pgarrison commented Nov 26, 2024

Updated with instructions to download to benchmarking_representations/morphology_appropriate_representation_learning/model_checkpoints

Copy link
Collaborator

@ritvikvasan ritvikvasan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Collaborator

@fatwir fatwir left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@pgarrison pgarrison merged commit 36e07a7 into main Nov 27, 2024
1 check passed
@pgarrison pgarrison deleted the ckpt-docs branch November 27, 2024 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Instructions for using checkpoints
3 participants