Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added hierarchy to user and developer api #779

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
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
113 changes: 0 additions & 113 deletions docs/developer.rst

This file was deleted.

15 changes: 15 additions & 0 deletions docs/developer/backends.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Backends
~~~~~~~~
.. module:: moscot.backends
.. currentmodule:: moscot
.. autosummary::
:toctree: genapi

backends.ott.SinkhornSolver
backends.ott.GWSolver
backends.ott.OTTOutput
backends.ott.GraphOTTOutput
backends.ott.GENOTLinSolver
backends.ott.output.OTTNeuralOutput
backends.utils.get_solver
backends.utils.get_available_backends
22 changes: 22 additions & 0 deletions docs/developer/base.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Base
~~~~
.. module:: moscot.base
.. currentmodule:: moscot.base
.. autosummary::
:toctree: genapi

problems.BaseProblem
problems.OTProblem
problems.BirthDeathProblem
problems.BaseCompoundProblem
problems.CompoundProblem
cost.BaseCost
problems.CondOTProblem
problems.AnalysisMixin
problems.BirthDeathMixin
problems.birth_death.beta
problems.birth_death.delta
solver.BaseSolver
solver.OTSolver
output.BaseDiscreteSolverOutput
output.MatrixSolverOutput
12 changes: 12 additions & 0 deletions docs/developer/costs.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Costs
~~~~~
.. module:: moscot.costs
.. currentmodule:: moscot
.. autosummary::
:toctree: genapi

costs.BarcodeDistance
costs.LeafDistance
costs.get_cost
costs.get_available_costs
costs.register_cost
12 changes: 12 additions & 0 deletions docs/developer/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Developer API
#############

.. module:: moscot

.. toctree::
:maxdepth: 3

backends
costs
base
utils
21 changes: 21 additions & 0 deletions docs/developer/utils.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Utils
~~~~~
.. module:: moscot.utils
.. currentmodule:: moscot.utils
.. autosummary::
:toctree: genapi

subset_policy.SubsetPolicy
subset_policy.OrderedPolicy
subset_policy.StarPolicy
subset_policy.ExternalStarPolicy
subset_policy.SequentialPolicy
subset_policy.TriangularPolicy
subset_policy.ExplicitPolicy
data.transcription_factors
data.proliferation_markers
data.apoptosis_markers
tagged_array.TaggedArray
tagged_array.Tag
tagged_array.DistributionCollection
tagged_array.DistributionContainer
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Important resources
Learn how to install :mod:`moscot`.

.. grid-item-card:: User API
:link: user
:link: user/index
:link-type: doc

Find a detailed documentation of :mod:`moscot`.
Expand Down Expand Up @@ -85,8 +85,8 @@ Important resources

installation
user_guide
user
developer
user/index
developer/index
contributing
notebooks/tutorials/index
notebooks/examples/index
Expand Down
61 changes: 0 additions & 61 deletions docs/user.rst

This file was deleted.

13 changes: 13 additions & 0 deletions docs/user/biological.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Biological Problems
~~~~~~~~~~~~~~~~~~~
.. module:: moscot.problems
.. currentmodule:: moscot.problems
.. autosummary::
:toctree: genapi

time.TemporalProblem
time.LineageProblem
space.AlignmentProblem
space.MappingProblem
spatiotemporal.SpatioTemporalProblem
cross_modality.TranslationProblem
18 changes: 18 additions & 0 deletions docs/user/datasets.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Datasets
~~~~~~~~
.. module:: moscot.datasets
.. currentmodule:: moscot
.. autosummary::
:toctree: genapi

datasets.bone_marrow
datasets.c_elegans
datasets.drosophila
datasets.hspc
datasets.mosta
datasets.pancreas_multiome
datasets.sciplex
datasets.sim_align
datasets.simulate_data
datasets.tedsim
datasets.zebrafish
11 changes: 11 additions & 0 deletions docs/user/generic.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Generic Problems
~~~~~~~~~~~~~~~~
.. module:: moscot.problems
.. currentmodule:: moscot.problems
.. autosummary::
:toctree: genapi

generic.SinkhornProblem
generic.GWProblem
generic.FGWProblem
generic.GENOTLinProblem
16 changes: 16 additions & 0 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
User API
########

.. module:: moscot

Import :mod:`moscot` as::

import moscot as mt

.. toctree::
:maxdepth: 3

biological
generic
plotting
datasets
11 changes: 11 additions & 0 deletions docs/user/plotting.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Plotting
~~~~~~~~
.. module:: moscot.plotting
.. currentmodule:: moscot
.. autosummary::
:toctree: genapi

plotting.cell_transition
plotting.sankey
plotting.push
plotting.pull
Loading