Skip to content

Commit 82ae395

Browse files
authored
Wrap lightning's train as an ST method (#40)
* add train method to starling class, injecting defaults * return AnnData object from result method * remove redundant type descriptions in docstrings * update second tutorial link in README * remove notebook output * only check for size column if model_cell_size is True
1 parent f740e39 commit 82ae395

File tree

8 files changed

+292
-1534
lines changed

8 files changed

+292
-1534
lines changed

Diff for: Dockerfile

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ RUN python3 -m venv $VIRTUAL_ENV && \
3535

3636
USER $USERNAME
3737

38-
COPY . .
38+
COPY --chown=${USER_UID}:${USER_GID} . .
3939

4040
RUN poetry install --with docs,dev

Diff for: README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ It outputs:
1111

1212
A **preprint** describing the method and introducing a novel benchmarking workflow is available: [Lee et al. (2024) _Segmentation error aware clustering for highly multiplexed imaging_](https://www.biorxiv.org/content/10.1101/2024.02.29.582827v1)
1313

14-
A **tutorial** outlining basic usage is available [here](https://github.com/camlab-bioml/starling/blob/main/docs/source/tutorial/getting-started.ipynb).
14+
A **tutorial** outlining basic usage is available [here][tutorial].
1515

1616
![Model](https://github.com/camlab-bioml/starling/raw/main/starling-schematic600x.png)
1717

Diff for: docs/source/conf.py

+2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121

2222
nb_execution_timeout = -1
2323

24+
autodoc_typehints = "description"
25+
2426
html_theme = "sphinx_rtd_theme"
2527
html_static_path = ["_static"]
2628
html_css_files = [

0 commit comments

Comments
 (0)