diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index b54818234..000000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,18 +0,0 @@ -# Read the Docs configuration file -# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details - -# Required -version: 2 - -build: - os: ubuntu-22.04 - tools: - python: "3.9" - -# Build documentation in the docs/ directory with Sphinx -sphinx: - configuration: docs/source/conf.py - -python: - install: - - requirements: docs/requirements.txt diff --git a/README.rst b/README.rst index 512a733c9..8845115af 100644 --- a/README.rst +++ b/README.rst @@ -48,9 +48,9 @@ :alt: GitLab mirror for this repository :target: https://gitlab.actcognitive.org/itmo-nss-team/Fedot.Industrial -.. |docs| image:: https://readthedocs.org/projects/ebonite/badge/ - :target: https://fedotindustrial.readthedocs.io/en/latest/ - :alt: Documentation Status +.. |docs| image:: https://img.shields.io/badge/docs-WIKI-blue.svg + :target: https://github.com/aimclub/Fedot.Industrial/wiki + :alt: Documentation Page .. |binder| image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/aimclub/Fedot.Industrial/HEAD @@ -147,13 +147,13 @@ Fedot.Ind предоставляет высокоуровневый API, кот rounding_order=3, metric_names=['f1', 'accuracy', 'precision', 'roc_auc']) -Больше информации об использовании API доступно в `соответствующей секции `__ документации. +Больше информации об использовании API доступно на `странице документации `__. Документация и примеры ========================== -Наиболее оплная документация собрана в `readthedocs`_. +Наиболее оплная документация собрана в `wikipage`_. Полезные материалы и примеры использования находятся в папке `examples`_ репозитория. @@ -456,7 +456,7 @@ HouseholdPowerConsumption1, AppliancesEnergy, HouseholdPowerConsumption2, IEEEPP .. _AutoML framework FEDOT: https://github.com/aimclub/FEDOT .. _UCR archive: https://www.cs.ucr.edu/~eamonn/time_series_data/ .. _main branch: https://github.com/aimclub/Fedot.Industrial -.. _readthedocs: https://fedotindustrial.readthedocs.io/en/latest/ +.. _wikipage: https://github.com/aimclub/Fedot.Industrial/wiki .. _examples: https://github.com/aimclub/Fedot.Industrial/tree/main/examples Поддержка diff --git a/README_en.rst b/README_en.rst index 7fe3c3e91..bc33cda85 100644 --- a/README_en.rst +++ b/README_en.rst @@ -49,9 +49,9 @@ :alt: GitLab mirror for this repository :target: https://gitlab.actcognitive.org/itmo-nss-team/Fedot.Industrial -.. |docs| image:: https://readthedocs.org/projects/ebonite/badge/ - :target: https://fedotindustrial.readthedocs.io/en/latest/ - :alt: Documentation Status +.. |docs| image:: https://img.shields.io/badge/docs-WIKI-blue.svg + :target: https://github.com/aimclub/Fedot.Industrial/wiki + :alt: Documentation Page .. |binder| image:: https://mybinder.org/badge_logo.svg :target: https://mybinder.org/v2/gh/aimclub/Fedot.Industrial/HEAD @@ -146,13 +146,13 @@ In the case below, ``x_train / x_test``, ``y_train / y_test`` are ``pandas.DataF rounding_order=3, metric_names=['f1', 'accuracy', 'precision', 'roc_auc']) -More information about the API is available in the `documentation `__ section. +More information about the API is available in the `documentation `__ section: Documentation and examples ========================== -The comprehensive documentation is available on `readthedocs`_. +The comprehensive documentation is available on `wikipage`_. Useful tutorials and examples can be found in the `examples`_ folder. @@ -449,7 +449,7 @@ are published. .. _AutoML framework FEDOT: https://github.com/aimclub/FEDOT .. _UCR archive: https://www.cs.ucr.edu/~eamonn/time_series_data/ .. _main branch: https://github.com/aimclub/Fedot.Industrial -.. _readthedocs: https://fedotindustrial.readthedocs.io/en/latest/ +.. _wikipage: https://github.com/aimclub/Fedot.Industrial/wiki .. _examples: https://github.com/aimclub/Fedot.Industrial/tree/main/examples Supported by diff --git a/docs/Makefile b/docs/Makefile deleted file mode 100644 index 92dd33a1a..000000000 --- a/docs/Makefile +++ /dev/null @@ -1,20 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = _build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -.PHONY: help Makefile - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/__init__.py b/docs/__init__.py deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/make.bat b/docs/make.bat deleted file mode 100644 index 21dcdcef8..000000000 --- a/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR= source -set BUILDDIR=_build - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.https://www.sphinx-doc.org/ - exit /b 1 -) - -if "%1" == "" goto help - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/requirements.txt b/docs/requirements.txt deleted file mode 100644 index 59a9dfc3a..000000000 --- a/docs/requirements.txt +++ /dev/null @@ -1,25 +0,0 @@ -fedot @ https://github.com/nccr-itmo/FEDOT/archive/master.zip - -# workaround for macos -catboost==1.1.1; sys_platform == 'darwin' - -MKLpy==0.6 -PyMonad==2.4.0 -PyWavelets==1.4.1 - -fastcore -fastai -distributed -datasetsforecast - -tensorly==0.8.1 -torch==2.1.0 -torchvision -statsforecast==1.5.0 - -chardet -fedot -torch -sphinx -sphinx_rtd_theme -autodocsumm diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html deleted file mode 100644 index f810f01a8..000000000 --- a/docs/source/_templates/layout.html +++ /dev/null @@ -1,12 +0,0 @@ -{% extends "!layout.html" %} - {% block footer %} {{ super() }} - - -{% endblock %} diff --git a/docs/source/about.rst b/docs/source/about.rst deleted file mode 100644 index f89e038ec..000000000 --- a/docs/source/about.rst +++ /dev/null @@ -1,11 +0,0 @@ -About us -======== - -The FEDOT.Industrial is developed and maintained by the `NSS Lab `__ team. - -Our laboratory is part of the National Center for Cognitive Technologies (ITMO University, Russia), -which provides cutting-edge software and algorithmic solutions. We focus on natural systems simulations, -generative design of real and virtual objects, data-driven modeling, automated machine learning. - -We are always open to new ideas and collaborations. If you have any questions or suggestions, -please contact us. diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst deleted file mode 100644 index cc1e57c71..000000000 --- a/docs/source/architecture.rst +++ /dev/null @@ -1,45 +0,0 @@ -Architecture of FEDOT.Industrial -================================ - -The FEDOT.Industrial framework is a versatile tool for the time-series -engineer. The software is designed to minimize user involvement in the -programming area while maximizing the quality of the results obtained -for tasks such as: time series classification and forecasting, anomaly detection, and -computer vision tasks including object detection and recognition. - - -We propose the data-driven automated time series classification -approach, which main idea is to combine selection of features in one -feature space and an automated model design using a -graph-based pipeline representation and evolutionary optimization. - -.. image:: img_introduction/architecture.png - :width: 700px - :align: center - :alt: Architecture of FEDOT - -The input data (Input Data block) in the form of -time series goes to the ``Feature Design`` block. The selected features are the -input data for the ``Model Design`` block, where the evolutionary algorithm -(``Evolutionary Optimizer`` block) selects the optimal Pipeline for solving the problem. -The final pipelines are then applied to obtain predictions, which -are interpreted with application in the corresponding block. To evaluate -the quality of the intermediate results and the final predictions, the -``Quality Analyzer`` block is created, implementing various evaluation metrics. - -For the machine learning pipeline creation, represented as an acyclic -graph, we used an approach based on an evolutionary algorithm [1]_. -This pipeline combines multiple methods of feature extraction and -machine learning models. The aim of the evolutionary optimiser is to -obtain the effective but computationally lightweight pipeline avoiding -over-complicated solutions. - -It could be used by specialists without machine learning or data -science experience for application tasks in their professional domain, -where the primary data type is time series. - - - -.. [1] Nikitin, Nikolay O., et al. "Automated evolutionary approach - for the design of composite machine learning pipelines." - Future Generation Computer Systems 127 (2022): 109-125. \ No newline at end of file diff --git a/docs/source/citation.rst b/docs/source/citation.rst deleted file mode 100644 index e216c3b32..000000000 --- a/docs/source/citation.rst +++ /dev/null @@ -1,38 +0,0 @@ -How to cite us -================ -Here is a list of options if you'd like to cite us in your paper: - - -Repository ----------- - -.. code-block:: console - - @online{fedot_industrial, - author = {Revin, Ilya and Potemkin, Vadim and Balabanov, Nikita and Nikitin, Nikolay}, - title = {FEDOT.Industrial - Framework for automated time series analysis}, - year = 2022, - url = {https://github.com/ITMO-NSS-team/Fedot.Industrial}, - urldate = {2022-05-05} - } - -Our articles ------------- - - -`Automated machine learning approach for time series classification pipelines using -evolutionary optimization`_ - -.. code-block:: console - - @article{revin2023automated, - title={Automated machine learning approach for time series classification pipelines using evolutionary optimization}, - author={Revin, Ilia and Potemkin, Vadim A and Balabanov, Nikita R and Nikitin, Nikolay O}, - journal={Knowledge-Based Systems}, - volume={268}, - pages={110483}, - year={2023}, - publisher={Elsevier} - } - -.. _`Automated machine learning approach for time series classification pipelines using evolutionary optimization`: https://www.sciencedirect.com/science/article/abs/pii/S0950705123002332 diff --git a/docs/source/conf.py b/docs/source/conf.py deleted file mode 100644 index 8c49f6c60..000000000 --- a/docs/source/conf.py +++ /dev/null @@ -1,107 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -from sphinx.builders.html import StandaloneHTMLBuilder -import os -import datetime -import sys -sys.path.insert(0, os.path.abspath('../..')) - -# -- Project information ----------------------------------------------------- - -project = 'FEDOT Industrial' -copyright = '2021-{}, NSS Lab'.format(datetime.datetime.now().year) -author = 'NSS Lab' - -# The full version, including alpha/beta/rc tags -release = '0.4.0' - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx_rtd_theme', - 'sphinx.ext.autodoc', - 'sphinx.ext.coverage', - 'sphinx.ext.napoleon', - 'sphinx.ext.viewcode', - 'sphinx.ext.mathjax', - 'autodocsumm', - 'sphinx.ext.autosummary', - 'sphinx.ext.autodoc.typehints', - 'sphinx.ext.graphviz', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -StandaloneHTMLBuilder.supported_image_types = [ - 'image/svg+xml', - 'image/gif', - 'image/png', - 'image/jpeg' -] -html_theme = "sphinx_rtd_theme" -html_logo = '../img/fedot-industrial.png' -html_theme_options = { - 'logo_only': True, - 'display_version': False, -} -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['_static'] - -# -- Extension configuration ------------------------------------------------- - -# autodoc_inherit_docstrings = False -# napoleon_google_docstring = True -# napoleon_include_init_with_doc = True -napoleon_google_docstring = True -napoleon_numpy_docstring = False -napoleon_include_init_with_doc = False -napoleon_include_private_with_doc = True -napoleon_include_special_with_doc = True -napoleon_use_admonition_for_examples = True -napoleon_use_admonition_for_notes = True -napoleon_use_admonition_for_references = False -napoleon_use_ivar = True -napoleon_use_keyword = True -napoleon_use_param = True -napoleon_use_rtype = True -napoleon_attr_annotations = False - -autodoc_default_options = { - 'members': True, - 'undoc-members': False, - 'show-inheritance': True, - 'member-order': 'bysource', - 'ignore-module-all': True, -} -autoclass_content = 'class' -autodoc_typehints = 'signature' -autodoc_typehints_format = 'short' -autodoc_mock_imports = ['objgraph', 'memory_profiler', 'gprof2dot', 'snakeviz'] diff --git a/docs/source/contribution.rst b/docs/source/contribution.rst deleted file mode 100644 index 0d520997b..000000000 --- a/docs/source/contribution.rst +++ /dev/null @@ -1,172 +0,0 @@ -Contribution -============ - -We welcome you to `check the existing -issues `__ for bugs or -enhancements to work on. If you have an idea for an extension to FEDOT.Industrial, -please `file a new -issue `__ so we can -discuss it. - -Make sure to familiarize yourself with the project layout before making -any major contributions. - - -How to contribute ------------------ - -The preferred way to contribute to FEDOT.Industrial is to fork the `main -repository `__ on GitHub: - -1. Fork the `project repository `__: - click on the 'Fork' button near the top of the page. This creates a - copy of the code under your account on the GitHub server. - -2. Clone this copy to your local disk: - - :: - - $ git clone git@github.com:ITMO-NSS-team/Fedot.Industrial.git - $ cd FEDOT.Industrial - -3. Create a branch to hold your changes: - - :: - - $ git checkout -b my-contribution - -4. Make sure your local environment is setup correctly for development. - Installation instructions are almost identical to `the user - instructions `__ except that FEDOT.Industrial should *not* be - installed. If you have FEDOT.Industrial installed on your computer then make - sure you are using a virtual environment that does not have FEDOT.Industrial - installed. - -5. Start making changes on your newly created branch, remembering to - never work on the ``main`` branch! Work on this copy on your - computer using Git to do the version control. - -6. To check your changes haven't broken any existing tests and to check - new tests you've added pass run the following (note, you must have - the ``nose`` package installed within your dev environment for this - to work): - - :: - - $ pytest -s - -7. When you're done editing and local testing, run: - - :: - - $ git add modified_files - $ git commit - -to record your changes in Git, then push them to GitHub with: - -:: - - $ git push -u origin my-contribution - -Finally, go to the web page of your fork of the FEDOT.Industrial repo, and click -'Pull Request' (PR) to send your changes to the maintainers for review. - -(If it looks confusing to you, then look up the `Git -documentation `__ on the web.) - -Before submitting your pull request ------------------------------------ - -Before you submit a pull request for your contribution, please work -through this checklist to make sure that you have done everything -necessary so we can efficiently review and accept your changes. - -If your contribution changes FEDOT.Industrial in any way: - -- Update the - `documentation `__ - so all of your changes are reflected there. - -- Update the - `README `__ - if anything there has changed. - -If your contribution involves any code changes: - -- Update the `project unit - tests `__ to - test your code changes. - -- Make sure that your code is properly commented with - `docstrings `__ that have structure - according to `Google-style docstrings `__ - and comments explaining your rationale behind non-obvious coding - practices. - -If your contribution requires a new library dependency: - -- Double-check that the new dependency is easy to install via ``pip`` - or Anaconda and supports Python 3. If the dependency requires a - complicated installation, then we most likely won't merge your - changes because we want to keep FEDOT.Industrial easy to install. - -- Add the required version of the library to - `requirements.txt `__ - -Contribute to the documentation -------------------------------- -Take care of the documentation. - -All the documentation is created with the Sphinx autodoc feature. Use .. -automodule:: section which describes all the code in the module. - -- If a new package with several scripts: - - 1. Go to `docs/source/Industrial `__ and create new your_name_for_file.rst file. - - 2. Add a Header underlined with “=” sign. It’s crucial. - - 3. Add automodule or autoclass description for each of your scripts. :: - - .. automodule:: core.your.first.script.path - :members: - :no-undoc-members: - - .. autoclass:: core.your.second.script.path.class - :members: - :no-undoc-members: - ... - - 4. Add your_name_for_file to the toctree at docs/source/Industrial/index.rst - -- If a new module to the existed package: - - Most of the sections are already described in `docs/source/Industrial `__ , - so you can: - - - choose the most appropriate and repeat 3-d step from the previous section. - - or create a new one and repeat 2-3 steps from the previous section. - -- If a new function or a class to the existing module: - - Be happy. Everything is already done for you. - -After submitting your pull request ----------------------------------- - -After submitting your pull request, -`Travis-CI `__ will automatically run unit tests -on your changes and make sure that your updated code builds and runs on -Python 3. We also use services that automatically check code quality and -test coverage. - -Check back shortly after submitting your pull request to make sure that -your code passes these checks. If any of the checks come back with a red -X, then do your best to address the errors. - -Acknowledgements ----------------- - -This document guide is based on well-written `TPOT Framework -contribution -guide `__. \ No newline at end of file diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst deleted file mode 100644 index e60f86946..000000000 --- a/docs/source/examples/index.rst +++ /dev/null @@ -1,17 +0,0 @@ -Examples -================= - - -This directory contains examples and applications of the Fedot.Industrial framework. - -This page is under construction. In the meantime, you can check the GitHub: - -- `Time series classification example `_ - -- `Regression example `_ - -- `Forecasting example `_ - -- `Explainability of results `_ - -- `Real-world cases `_ diff --git a/docs/source/img_introduction/architecture.png b/docs/source/img_introduction/architecture.png deleted file mode 100644 index dd10c9c67..000000000 Binary files a/docs/source/img_introduction/architecture.png and /dev/null differ diff --git a/docs/source/img_introduction/fedot-industrial.png b/docs/source/img_introduction/fedot-industrial.png deleted file mode 100644 index f3716ee65..000000000 Binary files a/docs/source/img_introduction/fedot-industrial.png and /dev/null differ diff --git a/docs/source/index.rst b/docs/source/index.rst deleted file mode 100644 index ffaaaa5ad..000000000 --- a/docs/source/index.rst +++ /dev/null @@ -1,27 +0,0 @@ -Welcome to FEDOT Industrial's documentation! -============================================ - -Here you can find comprehensive documentation for the AutoML framework -`FEDOT.Industrial `__ - -It provides a set of tools for industrial type of tasks, such as time -series forecasting, classification, and regression. -The project is based on the `FEDOT AutoML framework `__ using its algorithmic -kernel in terms of evolutionary optimization and obtaining graph-like -pipelines. - - -Content -======== -.. toctree:: - :maxdepth: 1 - - installation - quickstart - architecture - modules/index - examples/index - contribution - about - citation - license diff --git a/docs/source/installation.rst b/docs/source/installation.rst deleted file mode 100644 index c3dc63570..000000000 --- a/docs/source/installation.rst +++ /dev/null @@ -1,23 +0,0 @@ -.. _installation: - -How to install -================ - -There are two ways to install Fedot.Industrial: - -from PyPI ---------- -.. code-block:: console - - pip install fedot_ind - - -from GitHub ------------------------- - -.. code-block:: console - - git clone https://github.com/ITMO-NSS-team/Fedot.Industrial.git - cd FEDOT.Industrial - pip install -r requirements.txt - pytest -s test/ diff --git a/docs/source/license.rst b/docs/source/license.rst deleted file mode 100644 index e8b7f6c9a..000000000 --- a/docs/source/license.rst +++ /dev/null @@ -1,34 +0,0 @@ -License information -=================== - -.. code-block:: console - - BSD 3-Clause License - - Copyright (c) 2022, Natural Systems Simulation Lab - All rights reserved. - - Redistribution and use in source and binary forms, with or without - modification, are permitted provided that the following conditions are met: - - 1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - - 2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - - 3. Neither the name of the copyright holder nor the names of its - contributors may be used to endorse or promote products derived from - this software without specific prior written permission. - - THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" - AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE - IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE - DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE - FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL - DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR - SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER - CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, - OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE - OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/docs/source/modules/forecasting/ssa_forecasting_api.rst b/docs/source/modules/forecasting/ssa_forecasting_api.rst deleted file mode 100644 index 2b57caea2..000000000 --- a/docs/source/modules/forecasting/ssa_forecasting_api.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _ssa-forecasing-label: - -SSA (singular spectrum analysis) forecaster -=========================================== - -.. autoclass:: fedot_ind.core.models.ts_forecasting.ssa_forecaster.SSAForecasterImplementation - :no-undoc-members: - :show-inheritance: - :inherited-members: diff --git a/docs/source/modules/index.rst b/docs/source/modules/index.rst deleted file mode 100644 index 06cfcded8..000000000 --- a/docs/source/modules/index.rst +++ /dev/null @@ -1,49 +0,0 @@ -Modules -================ - -The following modules are available: - -Main API modules ------------------ -.. toctree:: - :maxdepth: 1 - - industrial_api - - - -Time series classification --------------------------- - -.. toctree:: - :maxdepth: 1 - - ts_classification/models_tsc/base_extractor_api - ts_classification/models_tsc/stats_extractor_api - ts_classification/models_tsc/topological_extractor_api - - ts_classification/model_ensemblers - - - -Forecasting ------------ - -.. toctree:: - :maxdepth: 1 - - forecasting/ssa_forecasting_api - - -Useful tools ------------- - -.. toctree:: - :maxdepth: 1 - - tools/data_loader_api - tools/results_picker_api - tools/tsc_ds_generator - tools/ts_generator - - diff --git a/docs/source/modules/industrial_api.rst b/docs/source/modules/industrial_api.rst deleted file mode 100644 index f3d013d65..000000000 --- a/docs/source/modules/industrial_api.rst +++ /dev/null @@ -1,7 +0,0 @@ -.. _industrial-class-label: - -FEDOT.Industrial API -==================== - -.. autoclass:: fedot_ind.api.main.FedotIndustrial - :no-undoc-members: diff --git a/docs/source/modules/tools/data_loader_api.rst b/docs/source/modules/tools/data_loader_api.rst deleted file mode 100644 index 542cf29c3..000000000 --- a/docs/source/modules/tools/data_loader_api.rst +++ /dev/null @@ -1,12 +0,0 @@ -Time Series Data Loader -======================= - -This is a tool for loading time series data for classification experiment -either from local directory or from `UCR archive`_. If desired dataset is not found in local -``data`` folder, it will be downloaded from the archive and saved in corresponding directory -in ``.tsv`` format. - -.. autoclass:: fedot_ind.tools.loader.DataLoader - :no-undoc-members: - -.. _UCR archive: http://www.timeseriesclassification.com \ No newline at end of file diff --git a/docs/source/modules/tools/results_picker_api.rst b/docs/source/modules/tools/results_picker_api.rst deleted file mode 100644 index 300051760..000000000 --- a/docs/source/modules/tools/results_picker_api.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. _resultspicker-class-label: - -Results Picker -================= - -Module for parsing the results of time series classification experiments. - -.. autoclass:: fedot_ind.core.architecture.postprocessing.results_picker.ResultsPicker - :no-undoc-members: \ No newline at end of file diff --git a/docs/source/modules/tools/ts_generator.rst b/docs/source/modules/tools/ts_generator.rst deleted file mode 100644 index f1198ed2a..000000000 --- a/docs/source/modules/tools/ts_generator.rst +++ /dev/null @@ -1,7 +0,0 @@ -Time Series Generator -============================== - -.. autoclass:: fedot_ind.tools.synthetic.ts_generator.TimeSeriesGenerator - :members: - :show-inheritance: - :no-undoc-members: \ No newline at end of file diff --git a/docs/source/modules/tools/tsc_ds_generator.rst b/docs/source/modules/tools/tsc_ds_generator.rst deleted file mode 100644 index b5abd1807..000000000 --- a/docs/source/modules/tools/tsc_ds_generator.rst +++ /dev/null @@ -1,7 +0,0 @@ -Time Series Datasets Generator -============================== - -.. autoclass:: fedot_ind.tools.synthetic.ts_datasets_generator.TimeSeriesDatasetsGenerator - :members: - :show-inheritance: - :no-undoc-members: \ No newline at end of file diff --git a/docs/source/modules/ts_classification/model_ensemblers.rst b/docs/source/modules/ts_classification/model_ensemblers.rst deleted file mode 100644 index cca0abb49..000000000 --- a/docs/source/modules/ts_classification/model_ensemblers.rst +++ /dev/null @@ -1,21 +0,0 @@ -Model ensembles API -=================== - - -.. _base_ensemble_label: - -.. autoclass:: fedot_ind.core.ensemble.base_ensembler.BaseEnsemble - :members: - :member-order: - -.. _rank_ensemble_label: - -.. autoclass:: fedot_ind.core.ensemble.rank_ensembler.RankEnsemble - :members: - :member-order: bysource - -.. _kernel_ensemble_label: - -.. autoclass:: fedot_ind.core.ensemble.kernel_ensemble.KernelEnsembler - :members: - :member-order: bysource \ No newline at end of file diff --git a/docs/source/modules/ts_classification/models_tsc/base_extractor_api.rst b/docs/source/modules/ts_classification/models_tsc/base_extractor_api.rst deleted file mode 100644 index 315fb9574..000000000 --- a/docs/source/modules/ts_classification/models_tsc/base_extractor_api.rst +++ /dev/null @@ -1,7 +0,0 @@ -BaseExtractor -============== - -.. autoclass:: fedot_ind.core.models.base_extractor.BaseExtractor - :no-undoc-members: - :show-inheritance: - :inherited-members: diff --git a/docs/source/modules/ts_classification/models_tsc/stats_extractor_api.rst b/docs/source/modules/ts_classification/models_tsc/stats_extractor_api.rst deleted file mode 100644 index ca4feb326..000000000 --- a/docs/source/modules/ts_classification/models_tsc/stats_extractor_api.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. _quantile-extractor-label: - -Statistical feature extractor -============================== -This feature extractor is used to generate quantile features from a given -time series. - -.. autoclass:: fedot_ind.core.models.quantile.quantile_extractor.QuantileExtractor - :no-undoc-members: - :show-inheritance: - :inherited-members: diff --git a/docs/source/modules/ts_classification/models_tsc/topological_extractor_api.rst b/docs/source/modules/ts_classification/models_tsc/topological_extractor_api.rst deleted file mode 100644 index cd0fd6f64..000000000 --- a/docs/source/modules/ts_classification/models_tsc/topological_extractor_api.rst +++ /dev/null @@ -1,9 +0,0 @@ -Topological feature extractor -============================= -This feature extractor is used to generate Topological features from a given -time series. - -.. autoclass:: fedot_ind.core.models.topological.topological_extractor.TopologicalExtractor - :no-undoc-members: - :show-inheritance: - :inherited-members: diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst deleted file mode 100644 index fdafcdeb9..000000000 --- a/docs/source/quickstart.rst +++ /dev/null @@ -1,55 +0,0 @@ -Quickstart -========== - -First of all, you need to :ref:`install ` FEDOT.Industrial. - -Fedot.Ind provides a high-level API that allows you to use its capabilities in a simple way. -The API can be used for classification, regression, and time series forecasting problems, as well as -for anomaly detection. - -To use the API, follow these steps: - -1. Import ``FedotIndustrial`` class - -.. code-block:: python - - from fedot_ind.api.main import FedotIndustrial - -2. Initialize the FedotIndustrial object and define the type of modeling task. -It provides a fit/predict interface: - -- ``FedotIndustrial.fit()`` begins the feature extraction, optimization and returns the resulting composite pipeline; -- ``FedotIndustrial.predict()`` predicts target values for the given input data using an already fitted pipeline; -- ``FedotIndustrial.get_metrics()`` estimates the quality of predictions using selected metrics. - -NumPy arrays or Pandas DataFrames can be used as sources of input data. -In the case below, ``x_train``, ``y_train`` and ``x_test`` are ``numpy.ndarray()``: - -.. code-block:: python - - model = Fedot(problem='classification', - metric='f1', - timeout=5) - - model.fit(features=x_train, target=y_train) - prediction = model.predict(features=x_test) - metrics = model.get_metrics(target=y_test) - -In case of time series classification task you also can use our `DataLoader` to download data -from `UCR/UEA archive `_: - -.. code-block:: python - - from fedot_ind.tools.loader import DataLoader - - loader = DataLoader(dataset_name='ECG200') - train_data, test_data = loader.load_data() - - -You can also specify the folder to search if your own data is in `.ts`, `.tsv` or `arff` format: - -.. code-block:: python - - loader = DataLoader(dataset_name='YourDatasetName', folder_path='path/to/folder') - train_data, test_data = loader.load_data() - diff --git a/fedot_ind/api/main.py b/fedot_ind/api/main.py index a58e63edb..4f35773b7 100644 --- a/fedot_ind/api/main.py +++ b/fedot_ind/api/main.py @@ -232,10 +232,10 @@ def predict_proba(self, Args: predict_mode: ``default='default'``. Defines the mode of prediction. Could be 'default' or 'probs'. predict_data: tuple with test_features and test_target + calibrate_probs: ``default=False``. If True, calibrate probabilities Returns: the array with prediction probabilities - :param calibrate_probs: """ self.predict_data = self._process_input_data(predict_data) @@ -262,7 +262,8 @@ def finetune(self, train_data = self._process_input_data(train_data) if \ not self.api_controller.condition_check.input_data_is_fedot_type(train_data) else train_data - tuning_params = ApiConverter.tuning_params_is_none(tuning_params) + if tuning_params is None: + tuning_params = ApiConverter.tuning_params_is_none(tuning_params) tuning_params['metric'] = FEDOT_TUNING_METRICS[self.config_dict['problem']] for tuner_name, tuner_type in FEDOT_TUNER_STRATEGY.items(): diff --git a/tests/unit/api/main/test_api_main.py b/tests/unit/api/main/test_api_main.py index 13561ff60..8ad2b4412 100644 --- a/tests/unit/api/main/test_api_main.py +++ b/tests/unit/api/main/test_api_main.py @@ -140,7 +140,7 @@ def test_finetune(fedot_industrial_classification): industrial = fedot_industrial_classification data = univariate_clf_data() industrial.fit(data) - industrial.finetune(data) + industrial.finetune(train_data=data, tuning_params={'tuning_timeout': 0.1}) assert industrial.solver is not None diff --git a/tests/unit/core/models/model_impl/test_patch_tst.py b/tests/unit/core/models/model_impl/test_patch_tst.py index efca456c1..075783d2d 100644 --- a/tests/unit/core/models/model_impl/test_patch_tst.py +++ b/tests/unit/core/models/model_impl/test_patch_tst.py @@ -23,13 +23,13 @@ def ts_input_data(): return train_test_data_setup(train_input, validation_blocks=None) -def test_nbeats_model(ts_input_data): +def test_patch_tst_model(ts_input_data): train, test = ts_input_data with IndustrialModels(): - model = PipelineBuilder().add_node('patch_tst_model', params=dict( - epochs=10 - )).build() + model = PipelineBuilder().add_node('patch_tst_model', + params=dict(epochs=10) + ).build() model.fit(train) forecast = model.predict(test)