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

add quickstart to readme #81

Merged
merged 2 commits into from
Jan 2, 2025
Merged
Changes from all commits
Commits
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
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,23 @@ If you'd like to reproduce this analysis on our data, check out the following do

Coming soon

# Quickstart

Use the cytodl api to run any given experiment. For e.g., train a rotation invariant point cloud autoencoder on the PCNA dataset

```bash
from cyto_dl.api import CytoDLModel
from pathlib import Path

model = CytoDLModel()
model.root= Path(os.getcwd())
model.load_default_experiment('pcna/pc_equiv', output_dir = './')

model.print_config()

model.train()
```

# Contact

Allen Institute for Cell Science ([email protected])
Loading