From 6512588ee50d72296a8188b102e6261ccf86b0d1 Mon Sep 17 00:00:00 2001 From: Ritvik Vasan Date: Fri, 13 Dec 2024 12:24:38 -0800 Subject: [PATCH 1/2] add quickstart to readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 5095a1e..5535ef2 100644 --- a/README.md +++ b/README.md @@ -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 (cells@alleninstitute.org) From 9753605dbde10ec5e6912666e484df368d71b3ed Mon Sep 17 00:00:00 2001 From: Ritvik Vasan Date: Fri, 13 Dec 2024 12:26:25 -0800 Subject: [PATCH 2/2] run pre-commit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5535ef2..6d6d432 100644 --- a/README.md +++ b/README.md @@ -39,7 +39,7 @@ Use the cytodl api to run any given experiment. For e.g., train a rotation invar from cyto_dl.api import CytoDLModel from pathlib import Path -model =CytoDLModel() +model = CytoDLModel() model.root= Path(os.getcwd()) model.load_default_experiment('pcna/pc_equiv', output_dir = './')