Browse Source

[DOC] reformat API

pull/1/head
troyyyyy 2 years ago
parent
commit
523f9c2225
9 changed files with 29 additions and 161 deletions
  1. +4
    -15
      docs/API/abl.bridge.rst
  2. +4
    -14
      docs/API/abl.dataset.rst
  3. +4
    -13
      docs/API/abl.evaluation.rst
  4. +4
    -12
      docs/API/abl.learning.rst
  5. +4
    -23
      docs/API/abl.reasoning.rst
  6. +4
    -12
      docs/API/abl.structures.rst
  7. +5
    -37
      docs/API/abl.utils.rst
  8. +0
    -25
      docs/_static/custom.css
  9. +0
    -10
      docs/_templates/classtemplate.rst

+ 4
- 15
docs/API/abl.bridge.rst View File

@@ -1,18 +1,7 @@
.. role:: hidden
:class: hidden-section

abl.bridge
==================

.. currentmodule:: abl.bridge

Bridge
-------

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst

BaseBridge
SimpleBridge
.. automodule:: abl.bridge
:members:
:undoc-members:
:show-inheritance:

+ 4
- 14
docs/API/abl.dataset.rst View File

@@ -1,17 +1,7 @@
abl.dataset
==================

.. currentmodule:: abl.dataset

Dataset
-------

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst

BridgeDataset
ClassificationDataset
PredictionDataset
RegressionDataset
.. automodule:: abl.dataset
:members:
:undoc-members:
:show-inheritance:

+ 4
- 13
docs/API/abl.evaluation.rst View File

@@ -1,16 +1,7 @@
abl.evaluation
==================

.. currentmodule:: abl.evaluation

Metrics
-------

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst

BaseMetric
SymbolMetric
ReasoningMetric
.. automodule:: abl.evaluation
:members:
:undoc-members:
:show-inheritance:

+ 4
- 12
docs/API/abl.learning.rst View File

@@ -1,15 +1,7 @@
abl.learning
==================

.. currentmodule:: abl.learning

Learning
--------

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst

ABLModel
BasicNN
.. automodule:: abl.learning
:members:
:undoc-members:
:show-inheritance:

+ 4
- 23
docs/API/abl.reasoning.rst View File

@@ -1,26 +1,7 @@
abl.reasoning
==================

.. currentmodule:: abl.reasoning

Knowledge Base
--------------

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst

KBBase
GroundKB
PrologKB

Reasoner
---------

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst

Reasoner
.. automodule:: abl.reasoning
:members:
:undoc-members:
:show-inheritance:

+ 4
- 12
docs/API/abl.structures.rst View File

@@ -1,15 +1,7 @@
abl.structures
==================

.. currentmodule:: abl.structures

Data Structures
----------------

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst

BaseDataElement
ListData
.. automodule:: abl.structures
:members:
:undoc-members:
:show-inheritance:

+ 5
- 37
docs/API/abl.utils.rst View File

@@ -1,39 +1,7 @@
abl.utils
===========
==================

.. currentmodule:: abl.utils

Logger
-------

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst

ABLLogger

Cache
------

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst

Cache
abl_cache

Utils
------

.. autosummary::
:toctree: generated
:nosignatures:
:template: classtemplate.rst

confidence_dist
flatten
hamming_dist
reform_list
to_hashable
.. automodule:: abl.utils
:members:
:undoc-members:
:show-inheritance:

+ 0
- 25
docs/_static/custom.css View File

@@ -1,28 +1,3 @@
div.code-out > div.highlight > pre {
background-color: #d3effd !important;
}

.autosummary.longtable.docutils.align-default {
width: 100%;
}

.autosummary.longtable.docutils.align-default td {
word-wrap: break-word;
white-space: normal;
}

.row-odd td:first-child .pre {
font-size: 110%;
color: #4682B4;
}

.row-even td:first-child .pre {
font-size: 110%;
color: #4682B4;
}

.autosummary.longtable.docutils.align-default td:first-child {
width: 30%;
text-align: left;
}


+ 0
- 10
docs/_templates/classtemplate.rst View File

@@ -1,10 +0,0 @@
.. role:: hidden
:class: hidden-section

.. currentmodule:: {{ module }}

{{ name | underline }}

.. autoclass:: {{ name }}
:members:
:show-inheritance:

Loading…
Cancel
Save