Skip to content

Commit 735ef4f

Browse files
Merge pull request #477 from OmicsML/fix-doc
fix:doc
2 parents 44b706c + 4fe0493 commit 735ef4f

37 files changed

+178
-161
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ wandb/
1212
*.egg*
1313
__pycache__/
1414
build/
15+
_build/
1516
*.log
1617

1718
# =============================================================================

docs/source/DANCE 2.0/Preprocessing Function Parameter Search Space.rst

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/source/DANCE 2.0/Preprocessing Steps and Their Functions.rst renamed to docs/source/DANCE 2.0/Preprocessing Steps and Available Function Candidates.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
Preprocessing Steps and Their Functions
1+
Preprocessing Steps and Available Function Candidates
22
====================
33

44
This page lists the preprocessing functions included in each step.
55

6-
filter.gene
6+
Preprocessing Step: filter.gene
77
-----------
88

99
- :class:`dance.transforms.FilterGenesPercentile`
1010
- :class:`dance.transforms.FilterGenesScanpyOrder`
1111
- :class:`dance.transforms.FilterGenesPlaceHolder`
1212

13-
filter.cell
13+
Preprocessing Step: filter.cell
1414
-----------
1515

1616
- :class:`dance.transforms.FilterCellsScanpyOrder`
1717
- :class:`dance.transforms.FilterCellsPlaceHolder`
1818
- :class:`dance.transforms.FilterCellsCommonMod`
1919

20-
normalize
20+
Preprocessing Step: normalize
2121
---------
2222

2323
- :class:`dance.transforms.ColumnSumNormalize`
@@ -28,7 +28,7 @@ normalize
2828
- :class:`dance.transforms.tfidfTransform`
2929
- :class:`dance.transforms.NormalizePlaceHolder`
3030

31-
filter.gene(highly_variable)
31+
Preprocessing Step: filter.gene(highly_variable)
3232
-----------
3333

3434
- :class:`dance.transforms.FilterGenesTopK`
@@ -39,7 +39,7 @@ filter.gene(highly_variable)
3939
- :class:`dance.transforms.HighlyVariableGenesLogarithmizedByMeanAndDisp`
4040
- :class:`dance.transforms.FilterGenesNumberPlaceHolder`
4141

42-
feature.cell
42+
Preprocessing Step: feature.cell
4343
------------
4444

4545
- :class:`dance.transforms.CellPCA`
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Search Space of Preprocessing Function Parameters
2+
========================
3+
After identifying the optimal preprocessing function in Stage 2, Stage 3 involves parameter tuning for this function. The parameter search is guided by a configuration file that defines the search space, as detailed below. This file is user-editable to allow for customization.
4+
5+
.. literalinclude:: ../../../examples/tuning/step3_default_params.yaml
6+
:language: yaml
7+
:caption: examples/tuning/step3_default_params.yaml

docs/source/DANCE 2.0/experiments/celltype_annotation/actinn.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ actinn Config
33

44
This is the config for actinn.
55

6-
.. literalinclude:: ../../../../examples/tuning/cta_actinn/328_138/pipeline_params_tuning_config.yaml
6+
.. literalinclude:: ../../../../../examples/tuning/cta_actinn/328_138/pipeline_params_tuning_config.yaml
77
:language: yaml
88
:caption: examples/tuning/cta_actinn/328_138/pipeline_params_tuning_config.yaml

docs/source/DANCE 2.0/experiments/celltype_annotation/celltypist.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ celltypist Config
33

44
This is the config for celltypist.
55

6-
.. literalinclude:: ../../../../examples/tuning/cta_celltypist/328_138/pipeline_params_tuning_config.yaml
6+
.. literalinclude:: ../../../../../examples/tuning/cta_celltypist/328_138/pipeline_params_tuning_config.yaml
77
:language: yaml
88
:caption: examples/tuning/cta_celltypist/328_138/pipeline_params_tuning_config.yaml

docs/source/DANCE 2.0/experiments/celltype_annotation/scdeepsort.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ scdeepsort Config
33

44
This is the config for scdeepsort.
55

6-
.. literalinclude:: ../../../../examples/tuning/cta_scdeepsort/328_138/pipeline_params_tuning_config.yaml
6+
.. literalinclude:: ../../../../../examples/tuning/cta_scdeepsort/328_138/pipeline_params_tuning_config.yaml
77
:language: yaml
88
:caption: examples/tuning/cta_scdeepsort/328_138/pipeline_params_tuning_config.yaml

docs/source/DANCE 2.0/experiments/celltype_annotation/scheteronet.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ scheteronet Config
33

44
This is the config for scheteronet.
55

6-
.. literalinclude:: ../../../../examples/tuning/cta_scheteronet/328_138/pipeline_params_tuning_config.yaml
6+
.. literalinclude:: ../../../../../examples/tuning/cta_scheteronet/328_138/pipeline_params_tuning_config.yaml
77
:language: yaml
88
:caption: examples/tuning/cta_scheteronet/328_138/pipeline_params_tuning_config.yaml

docs/source/DANCE 2.0/experiments/celltype_annotation/singlecellnet.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ singlecellnet Config
33

44
This is the config for singlecellnet.
55

6-
.. literalinclude:: ../../../../examples/tuning/cta_singlecellnet/328_138/pipeline_params_tuning_config.yaml
6+
.. literalinclude:: ../../../../../examples/tuning/cta_singlecellnet/328_138/pipeline_params_tuning_config.yaml
77
:language: yaml
88
:caption: examples/tuning/cta_singlecellnet/328_138/pipeline_params_tuning_config.yaml

docs/source/DANCE 2.0/experiments/celltype_annotation/svm.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ svm Config
33

44
This is the config for svm.
55

6-
.. literalinclude:: ../../../../examples/tuning/cta_svm/328_138/pipeline_params_tuning_config.yaml
6+
.. literalinclude:: ../../../../../examples/tuning/cta_svm/328_138/pipeline_params_tuning_config.yaml
77
:language: yaml
88
:caption: examples/tuning/cta_svm/328_138/pipeline_params_tuning_config.yaml

0 commit comments

Comments
 (0)