Skip to content
Merged
Show file tree
Hide file tree
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
6 changes: 3 additions & 3 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,18 @@ jobs:
- uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v5
- name: Sphinx build
- name: MkDocs build
run: |
export ANNDATA_CUPY=0
uv run --group docs sphinx-build -v -W docs docs/_build
uv run --group docs mkdocs build
- name: Setup Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/configure-pages@v5
- name: Upload artifact
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
path: "docs/_build"
path: "site"

deploy:
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
Expand Down
9 changes: 6 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,13 @@ coverage.xml
.hypothesis/
.pytest_cache/

# Sphinx documentation
# Documentation
/site/
site/
docs/_build/
docs/assets/tutorial_images/*.png
!docs/assets/tutorial_images/step2_r2x.png
!docs/assets/tutorial_images/step3_fms.png

# PyBuilder
target/
Expand Down Expand Up @@ -79,8 +84,6 @@ venv.bak/
# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
Expand Down
Binary file not shown.
Binary file removed docs/_static/tutorial_images/step2_r2x.png
Binary file not shown.
Binary file removed docs/_static/tutorial_images/step3_fms.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed docs/_static/tutorial_images/step8_gene_factors.png
Binary file not shown.
Binary file not shown.
68 changes: 68 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# API Reference

## Factorization

::: RISE.factorization
options:
members:
- pf2
- export_factors
- load_factors
- correct_conditions

## Rank Selection

::: RISE.rank_selection
options:
members:
- bicv
- optimize_rank

## Preprocessing

::: parafac2.normalize
options:
members:
- prepare_dataset

## Visualization Functions

### General Plotting

::: RISE.plotting.general
options:
members:
- plot_r2x

### Factor Plotting

::: RISE.plotting.factors
options:
members:
- plot_condition_factors
- plot_eigenstate_factors
- plot_gene_factors

### PaCMAP Visualization

::: RISE.plotting.pacmap
options:
members:
- plot_labels_pacmap
- plot_gene_pacmap
- plot_wp_pacmap

### Rank Selection Plotting

::: RISE.plotting.rank_selection
options:
members:
- plot_bicv_r2x
- plot_rank_optimization

### Factor Stability

::: RISE.plotting.stability
options:
members:
- plot_fms_diff_ranks
Loading
Loading