abhinadduri commited on
Commit
2b95422
·
verified ·
1 Parent(s): e7749a5

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +37 -0
README.md ADDED
@@ -0,0 +1,37 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ State Transition model checkpoints are meant to be used with the [Arc State](https://pypi.org/project/arc-state/) package.
2
+
3
+ State is distributed via [`uv`](https://docs.astral.sh/uv). To train models on your own AnnDatas, please see the [repository](https://github.com/ArcInstitute/state) README.
4
+
5
+ ## Running inference from pypi
6
+
7
+ ```bash
8
+ uv tool install arc-state
9
+ ```
10
+
11
+ To
12
+
13
+ ```code
14
+ state tx infer --model_dir <ST-Parse_PATH> --pert_col cytokine --adata <INPUT_ADATA>.h5ad --output <OUTPUT_DIR>
15
+ ```
16
+
17
+ ## Running from source
18
+
19
+ ```bash
20
+ # Clone repo
21
+ git clone github.com:arcinstitute/state
22
+ cd state
23
+
24
+ # Initialize venv
25
+ uv venv
26
+
27
+ # Install
28
+ uv tool install -e .
29
+ ```
30
+
31
+ To generate embeddings given an AnnData:
32
+
33
+ ```code
34
+ state tx infer --model_dir <ST-Parse_PATH> --pert_col cytokine --adata <INPUT_ADATA>.h5ad --output <OUTPUT_DIR>
35
+ ```
36
+
37
+ For model licenses please see `MODEL_ACCEPTABLE_USE_POLICY.md`, `MODEL_LICENSE.md`, and `LICENSE.md`.