Skip to content

Commit

Permalink
Fixing API reference (#1557)
Browse files Browse the repository at this point in the history
  • Loading branch information
ItayGabbay committed Jun 1, 2022
1 parent 1343ac8 commit 0cb97cb
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 37 deletions.
20 changes: 8 additions & 12 deletions docs/source/api/deepchecks.core.rst
Expand Up @@ -17,15 +17,11 @@ deepchecks.core

.. rubric:: Classes

.. autosummary::
:caption: Classes
:toctree: generated

BaseCheck
CheckResult
CheckFailure
Condition
ConditionResult
ConditionCategory
BaseSuite
SuiteResult
.. autoclass:: BaseCheck
.. autoclass:: CheckResult
.. autoclass:: CheckFailure
.. autoclass:: Condition
.. autoclass:: ConditionResult
.. autoclass:: ConditionCategory
.. autoclass:: BaseSuite
.. autoclass:: SuiteResult
22 changes: 9 additions & 13 deletions docs/source/api/deepchecks.tabular.rst
Expand Up @@ -16,17 +16,13 @@ deepchecks.tabular
datasets

.. rubric:: Classes

.. autosummary::
:toctree: generated
:caption: Classes

Dataset
Context
Suite
SingleDatasetCheck
TrainTestCheck
ModelOnlyCheck
ModelComparisonContext
ModelComparisonCheck
ModelComparisonSuite
.. autoclass:: Dataset
.. autoclass:: Context
.. autoclass:: Suite
.. autoclass:: SingleDatasetCheck
.. autoclass:: TrainTestCheck
.. autoclass:: ModelOnlyCheck
.. autoclass:: ModelComparisonContext
.. autoclass:: ModelComparisonCheck
.. autoclass:: ModelComparisonSuite
20 changes: 8 additions & 12 deletions docs/source/api/deepchecks.vision.rst
Expand Up @@ -17,16 +17,12 @@ deepchecks.vision
utils

.. rubric:: Classes

.. autosummary::
:toctree: generated
:caption: Classes

VisionData
ClassificationData
DetectionData
Context
SingleDatasetCheck
TrainTestCheck
ModelOnlyCheck
Suite
.. autoclass:: VisionData
.. autoclass:: ClassificationData
.. autoclass:: DetectionData
.. autoclass:: Context
.. autoclass:: SingleDatasetCheck
.. autoclass:: TrainTestCheck
.. autoclass:: ModelOnlyCheck
.. autoclass:: Suite

0 comments on commit 0cb97cb

Please sign in to comment.