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
4 changes: 2 additions & 2 deletions docs/source/ae.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
AE
=====================

.. currentmodule:: ezyrb.ae
.. currentmodule:: ezyrb.reduction.ae

.. automodule:: ezyrb.ae
.. automodule:: ezyrb.reduction.ae

.. autosummary::
:toctree: _summaries
Expand Down
4 changes: 2 additions & 2 deletions docs/source/ann.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
ANN
=====================

.. currentmodule:: ezyrb.ann
.. currentmodule:: ezyrb.approximation.ann

.. automodule:: ezyrb.ann
.. automodule:: ezyrb.approximation.ann

.. autosummary::
:toctree: _summaries
Expand Down
5 changes: 4 additions & 1 deletion docs/source/code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,17 @@ Code Documentation
==================

.. toctree::
:maxdepth: 2
:maxdepth: 2

database
parameter
snapshot
approximation
linear
rbf
radius_neighbors_regressor
kneighbors_regressor
neighbors_regressor
gpr
ann
reduction
Expand Down
29 changes: 11 additions & 18 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@

import sys
import os
import shlex
import sphinx
from sphinx.errors import VersionRequirementError
import sphinx_rtd_theme
import time
import importlib.metadata

Expand All @@ -32,17 +29,11 @@
_DISTRIBUTION_METADATA = importlib.metadata.metadata("ezyrb")
project = _DISTRIBUTION_METADATA["Name"]
copyright = f'2016-{time.strftime("%Y")}, EZyRB contributors'
author = _DISTRIBUTION_METADATA["Author"]
author = _DISTRIBUTION_METADATA["Author-email"]


# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
needs_sphinx = '1.4'
if needs_sphinx > sphinx.__display_version__:
message = 'This project needs at least Sphinx v{0!s}'.format(needs_sphinx)
raise VersionRequirementError(message)

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
Expand All @@ -56,14 +47,16 @@
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'sphinx.ext.coverage',
'sphinx.ext.imgmath',
'sphinx.ext.ifconfig',
'sphinx.ext.mathjax',
]

intersphinx_mapping = {'python': ('http://docs.python.org/2', None),
'numpy': ('http://docs.scipy.org/doc/numpy/', None),
'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None),
'matplotlib': ('http://matplotlib.sourceforge.net/', None)}
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"numpy": ("https://numpy.org/doc/stable/", None),
"scipy": ("https://docs.scipy.org/doc/scipy/", None),
"matplotlib": ("https://matplotlib.org/stable", None),
}

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down Expand Up @@ -97,7 +90,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down Expand Up @@ -142,7 +135,7 @@
# classes and attributes. As side effects, this option ... ???
# If false, ... ???.
# The default is True.
viewcode_import = True
viewcode_follow_imported_members = True

# -- Options for HTML output ----------------------------------------------

Expand All @@ -157,7 +150,7 @@
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
Expand Down
2 changes: 0 additions & 2 deletions docs/source/database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ Database
:nosignatures:

Database
Database.parameters
Database.snapshots
Database.__getitem__
Database.__len__
Database.add
Expand Down
4 changes: 2 additions & 2 deletions docs/source/gpr.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
GPR
=====================

.. currentmodule:: ezyrb.gpr
.. currentmodule:: ezyrb.approximation.gpr

.. automodule:: ezyrb.gpr
.. automodule:: ezyrb.approximation.gpr

.. autosummary::
:toctree: _summaries
Expand Down
4 changes: 2 additions & 2 deletions docs/source/kneighbors_regressor.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
KNeighborsRegressor
=====================

.. currentmodule:: ezyrb.kneighbors_regressor
.. currentmodule:: ezyrb.approximation.kneighbors_regressor

.. automodule:: ezyrb.kneighbors_regressor
.. automodule:: ezyrb.approximation.kneighbors_regressor

.. autosummary::
:toctree: _summaries
Expand Down
4 changes: 2 additions & 2 deletions docs/source/linear.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
Linear
=====================

.. currentmodule:: ezyrb.linear
.. currentmodule:: ezyrb.approximation.linear

.. automodule:: ezyrb.linear
.. automodule:: ezyrb.approximation.linear

.. autosummary::
:toctree: _summaries
Expand Down
4 changes: 2 additions & 2 deletions docs/source/neighbors_regressor.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
NeighborsRegressor
=====================

.. currentmodule:: ezyrb.neighbors_regressor
.. currentmodule:: ezyrb.approximation.neighbors_regressor

.. automodule:: ezyrb.neighbors_regressor
.. automodule:: ezyrb.approximation.neighbors_regressor

.. autosummary::
:toctree: _summaries
Expand Down
17 changes: 17 additions & 0 deletions docs/source/parameter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Parameter
=====================

.. currentmodule:: ezyrb.parameter

.. automodule:: ezyrb.parameter

.. autosummary::
:toctree: _summaries
:nosignatures:

.. autoclass:: Parameter
:members:
:private-members:
:undoc-members:
:show-inheritance:
:noindex:
4 changes: 2 additions & 2 deletions docs/source/pod.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
POD
=====================

.. currentmodule:: ezyrb.pod
.. currentmodule:: ezyrb.reduction.pod

.. automodule:: ezyrb.pod
.. automodule:: ezyrb.reduction.pod

.. autosummary::
:toctree: _summaries
Expand Down
4 changes: 2 additions & 2 deletions docs/source/podae.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
PODAE
=====================

.. currentmodule:: ezyrb.pod_ae
.. currentmodule:: ezyrb.reduction.pod_ae

.. automodule:: ezyrb.pod_ae
.. automodule:: ezyrb.reduction.pod_ae

.. autosummary::
:toctree: _summaries
Expand Down
4 changes: 2 additions & 2 deletions docs/source/radius_neighbors_regressor.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
RadiusNeighborsRegressor
=====================

.. currentmodule:: ezyrb.radius_neighbors_regressor
.. currentmodule:: ezyrb.approximation.radius_neighbors_regressor

.. automodule:: ezyrb.radius_neighbors_regressor
.. automodule:: ezyrb.approximation.radius_neighbors_regressor

.. autosummary::
:toctree: _summaries
Expand Down
4 changes: 2 additions & 2 deletions docs/source/rbf.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
RBF
=====================

.. currentmodule:: ezyrb.rbf
.. currentmodule:: ezyrb.approximation.rbf

.. automodule:: ezyrb.rbf
.. automodule:: ezyrb.approximation.rbf

.. autosummary::
:toctree: _summaries
Expand Down
17 changes: 17 additions & 0 deletions docs/source/snapshot.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Snapshot
=====================

.. currentmodule:: ezyrb.snapshot

.. automodule:: ezyrb.snapshot

.. autosummary::
:toctree: _summaries
:nosignatures:

.. autoclass:: Snapshot
:members:
:private-members:
:undoc-members:
:show-inheritance:
:noindex:
8 changes: 8 additions & 0 deletions ezyrb/reduction/reduction.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,3 +21,11 @@ def transform(self):
@abstractmethod
def inverse_transform(self):
"""Abstract `inverse_transform`"""

@abstractmethod
def expand(self):
"""Abstract `expand`"""

@abstractmethod
def reduce(self):
"""Abstract `reduce`"""
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ dependencies = [
"numpy",
"scipy",
"matplotlib",
"scikit-learn>=1.0",
"scikit-learn",
"torch",
"datasets"
]
Expand Down