Create README.md

README.md

@@ -0,0 +1,37 @@
+State Transition model checkpoints are meant to be used with the [Arc State](https://pypi.org/project/arc-state/) package.
+
+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.
+
+## Running inference from pypi
+
+```bash
+uv tool install arc-state
+```
+
+To 
+
+```code
+state tx infer --model_dir <ST-Parse_PATH> --pert_col cytokine --adata <INPUT_ADATA>.h5ad --output <OUTPUT_DIR>
+```
+
+## Running from source
+
+```bash
+# Clone repo
+git clone github.com:arcinstitute/state
+cd state
+
+# Initialize venv
+uv venv
+
+# Install
+uv tool install -e .
+```
+
+To generate embeddings given an AnnData:
+
+```code
+state tx infer --model_dir <ST-Parse_PATH> --pert_col cytokine --adata <INPUT_ADATA>.h5ad --output <OUTPUT_DIR>
+```
+
+For model licenses please see `MODEL_ACCEPTABLE_USE_POLICY.md`, `MODEL_LICENSE.md`, and `LICENSE.md`.