diff --git a/README.md b/README.md index f8f5dd6..2799381 100644 --- a/README.md +++ b/README.md @@ -9,35 +9,35 @@ Welcome to AdaptiveResonanceLib, a comprehensive and modular Python library for AdaptiveResonanceLib includes implementations for the following ART models: - #### Elementary Clustering - - ART1 - - ART2 - - Bayesian ART - - Gaussian ART - - Hypersphere ART - - Ellipsoidal ART - - Fuzzy ART - - Quadratic Neuron ART - - Dual Vigilance ART + - [ART1](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.ART1) + - [ART2](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.ART2A) + - [Bayesian ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.BayesianART) + - [Gaussian ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.GaussianART) + - [Hypersphere ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.HypersphereART) + - [Ellipsoid ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.EllipsoidART) + - [Fuzzy ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.FuzzyART) + - [Quadratic Neuron ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.QuadraticNeuronART) - #### Metric Informed - - CVI ART - - iCVI Fuzzy ART + - [CVI ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.CVIART) + - [iCVI Fuzzy ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.iCVIFuzzyART) - #### Topological - - Topo ART + - [Topo ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.TopoART) + - [Dual Vigilance ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.DualVigilanceART) - #### Classification - - Simple ARTMAP + - [Simple ARTMAP](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.SimpleARTMAP) - #### Regression - - ARTMAP - - Fusion ART + - [ARTMAP](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.ARTMAP) + - [Fusion ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.FusionART) - #### Hierarchical - - DeepARTMAP - - SMART + - [DeepARTMAP](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.DeepARTMAP) + - [SMART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.SMART) - #### Data Fusion - - Fusion ART + - [Fusion ART](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.FusionART) - #### Reinforcement Learning - - FALCON - - TD-FALCON + - [FALCON](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.FALCON) + - [TD-FALCON](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.html#artlib.TD_FALCON) - #### Biclustering - - Biclustering ARTMAP + - [Biclustering ARTMAP](https://adaptiveresonancelib.readthedocs.io/en/latest/artlib.biclustering.html#artlib.biclustering.BARTMAP.BARTMAP) @@ -94,7 +94,7 @@ predictions = model.predict(test_X) ## Documentation -For more detailed documentation, including the full list of parameters for each model, visit our [documentation page](https://github.com/NiklasMelton/AdaptiveResonanceLib). +For more detailed documentation, including the full list of parameters for each model, visit our [Read the Docs page](https://adaptiveresonancelib.readthedocs.io/en/latest/index.html). diff --git a/docs/source/conf.py b/docs/source/conf.py index 6505a53..a6994c2 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -35,22 +35,6 @@ autoapi_ignore = ['*/experimental', '*/experimental/*'] autoapi_python_class_content = 'both' -myst_enable_extensions = [ - "colon_fence", - "deflist", - "html_admonition", - "html_image", - "linkify", - "replacements", - "smartquotes", - "strikethrough", - "substitution", - "tasklist", - "attrs_block", - "attrs_inline", - "fieldlist", -] - intersphinx_mapping = { 'python': ('https://docs.python.org/3', None), diff --git a/pyproject.toml b/pyproject.toml index ffe0d0d..a643bef 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -33,9 +33,9 @@ matplotlib = ">=3.3.3" [tool.poetry.dev-dependencies] pytest = "^6.2.2" -sphinx = "^5.0" +sphinx = "^6.2.1" sphinx-rtd-theme = "^1.0.0" # If you're using the Read the Docs theme -sphinx-autoapi = ">=1.8.1" +sphinx-autoapi = ">=3.0.0" myst-parser = "^1.0" [build-system] diff --git a/readthedocs.yaml b/readthedocs.yaml index 20f2017..2531ae2 100644 --- a/readthedocs.yaml +++ b/readthedocs.yaml @@ -1,17 +1,20 @@ -# readthedocs.yaml version: 2 + build: - os: ubuntu-22.04 + os: "ubuntu-22.04" tools: python: "3.9" - commands: - - pip install sphinx - - sphinx-build -b html docs/source/ $READTHEDOCS_OUTPUT/html # Correct output path + jobs: + post_create_environment: + # Install poetry + # https://python-poetry.org/docs/#installing-manually + - pip install poetry + post_install: + # Install dependencies with 'docs' dependency group + # https://python-poetry.org/docs/managing-dependencies/#dependency-groups + # VIRTUAL_ENV needs to be set manually for now. + # See https://github.com/readthedocs/readthedocs.org/pull/11152/ + - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with dev sphinx: - configuration: docs/source/conf.py # Correctly pointing to conf.py - -python: - install: - - method: pip - path: . + configuration: docs/source/conf.py \ No newline at end of file