Skip to content

Commit

Permalink
Docs fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
nicl-nno committed Jan 10, 2024
1 parent 8fb75e2 commit 3f794c0
Show file tree
Hide file tree
Showing 11 changed files with 54 additions and 56 deletions.
2 changes: 1 addition & 1 deletion docs/source/advanced/cli_call.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ FEDOT package with all dependencies.
*Pay attention that your FEDOT working project can differ from the package version installed in the environment!*
*For setting master version as a package in environment download it through pip from GitHub with command:*

``pip install git+https://github.com/nccr-itmo/FEDOT.git``
``pip install git+https://github.com/aimclub/FEDOT.git``

Start using
-----------
Expand Down
4 changes: 2 additions & 2 deletions docs/source/advanced/gpu_evaluation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ every time.
That is why we want to share the way we use RAPIDS:

- Clone the project
``git clone https://github.com/nccr-itmo/FEDOT.git``
``git clone https://github.com/aimclub/FEDOT.git``
- Use your lovely FTP client to copy the project to the host where the
Docker is preinstalled or make the deployment via IDE you use
- Pull the RAPIDS image via
Expand All @@ -36,5 +36,5 @@ This approach doesn’t has an entry point for the container so it allows
you make contributions and check the changes in place.


.. _Dockerfile: https://github.com/nccr-itmo/FEDOT/blob/master/gpu/Dockerfile
.. _Dockerfile: https://github.com/aimclub/FEDOT/blob/master/gpu/Dockerfile
.. _RAPIDS official page: https://rapids.ai/start.html
26 changes: 13 additions & 13 deletions docs/source/advanced/hyperparameters_tuning.rst
Original file line number Diff line number Diff line change
Expand Up @@ -705,27 +705,27 @@ Another examples can be found here:

**Regression**

* `Regression with tuning <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/regression/regression_with_tuning.py>`_
* `Regression refinement example <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/decompose/regression_refinement_example.py>`_
* `Regression with tuning <https://github.com/aimclub/FEDOT/blob/master/examples/simple/regression/regression_with_tuning.py>`_
* `Regression refinement example <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/decompose/regression_refinement_example.py>`_

**Classification**

* `Classification with tuning <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/classification/classification_with_tuning.py>`_
* `Classification refinement example <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/decompose/classification_refinement_example.py>`_
* `Resample example <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/classification/resample_example.py>`_
* `Pipeline tuning for classification task <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/pipeline_tune.py>`_
* `Classification with tuning <https://github.com/aimclub/FEDOT/blob/master/examples/simple/classification/classification_with_tuning.py>`_
* `Classification refinement example <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/decompose/classification_refinement_example.py>`_
* `Resample example <https://github.com/aimclub/FEDOT/blob/master/examples/simple/classification/resample_example.py>`_
* `Pipeline tuning for classification task <https://github.com/aimclub/FEDOT/blob/master/examples/simple/pipeline_tune.py>`_

**Forecasting**

* `Pipeline tuning for time series forecasting <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/time_series_forecasting/tuning_pipelines.py>`_
* `Tuning pipelines with sparse_lagged / lagged node <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/time_series_forecasting/sparse_lagged_tuning.py>`_
* `Topaz multi time series forecasting <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/time_series_forecasting/multi_ts_arctic_forecasting.py>`_
* `Custom model tuning <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/time_series_forecasting/custom_model_tuning.py>`_
* `Case: river level forecasting with composer <https://github.com/nccr-itmo/FEDOT/blob/master/cases/river_levels_prediction/river_level_case_composer.py>`_
* `Case: river level forecasting (manual) <https://github.com/nccr-itmo/FEDOT/blob/master/cases/river_levels_prediction/river_level_case_manual.py>`_
* `Pipeline tuning for time series forecasting <https://github.com/aimclub/FEDOT/blob/master/examples/simple/time_series_forecasting/tuning_pipelines.py>`_
* `Tuning pipelines with sparse_lagged / lagged node <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/time_series_forecasting/sparse_lagged_tuning.py>`_
* `Topaz multi time series forecasting <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/time_series_forecasting/multi_ts_arctic_forecasting.py>`_
* `Custom model tuning <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/time_series_forecasting/custom_model_tuning.py>`_
* `Case: river level forecasting with composer <https://github.com/aimclub/FEDOT/blob/master/cases/river_levels_prediction/river_level_case_composer.py>`_
* `Case: river level forecasting (manual) <https://github.com/aimclub/FEDOT/blob/master/cases/river_levels_prediction/river_level_case_manual.py>`_

**Multitask**

* `Multitask pipeline: classification and regression <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/multitask_classification_regression.py>`_
* `Multitask pipeline: classification and regression <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/multitask_classification_regression.py>`_

.. _GOLEM documentation: https://thegolem.readthedocs.io/en/latest/api/tuning.html
16 changes: 8 additions & 8 deletions docs/source/basics/tabular_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,17 +100,17 @@ More details you can find in the follow links:

**Simple**

* `Classification using API <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/classification/api_classification.py>`_
* `Regression using API <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/regression/api_regression.py>`_
* `Classification with tuning <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/classification/classification_with_tuning.py>`_
* `Regression with tuning <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/regression/regression_with_tuning.py>`_
* `Classification using API <https://github.com/aimclub/FEDOT/blob/master/examples/simple/classification/api_classification.py>`_
* `Regression using API <https://github.com/aimclub/FEDOT/blob/master/examples/simple/regression/api_regression.py>`_
* `Classification with tuning <https://github.com/aimclub/FEDOT/blob/master/examples/simple/classification/classification_with_tuning.py>`_
* `Regression with tuning <https://github.com/aimclub/FEDOT/blob/master/examples/simple/regression/regression_with_tuning.py>`_

**Advanced**

* `Multiclass classification problem <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/classification/multiclass_prediction.py>`_
* `Classification with unbalanced data <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/classification/resample_examples.py>`_
* `Image classification problem <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/classification/image_classification_problem.py>`_
* `Multiclass classification problem <https://github.com/aimclub/FEDOT/blob/master/examples/simple/classification/multiclass_prediction.py>`_
* `Classification with unbalanced data <https://github.com/aimclub/FEDOT/blob/master/examples/simple/classification/resample_examples.py>`_
* `Image classification problem <https://github.com/aimclub/FEDOT/blob/master/examples/simple/classification/image_classification_problem.py>`_

**Cases**

* `Case: Credit scoring problem <https://github.com/nccr-itmo/FEDOT/blob/master/cases/credit_scoring/credit_scoring_problem.py>`_
* `Case: Credit scoring problem <https://github.com/aimclub/FEDOT/blob/master/cases/credit_scoring/credit_scoring_problem.py>`_
24 changes: 12 additions & 12 deletions docs/source/basics/ts_forecasting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -608,21 +608,21 @@ Examples

**Simple**

* `Forecasting with FEDOT API <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/time_series_forecasting/api_forecasting.py>`_
* `Forecasting using cgru <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/time_series_forecasting/cgru.py>`_
* `Fitted values <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/time_series_forecasting/fitted_values.py>`_
* `Time-series gap-filling <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/time_series_forecasting/gapfilling.py>`_
* `Pipeline tuning for time-series forecasting <https://github.com/nccr-itmo/FEDOT/blob/master/examples/simple/time_series_forecasting/tuning_pipelines.py>`_
* `Forecasting with FEDOT API <https://github.com/aimclub/FEDOT/blob/master/examples/simple/time_series_forecasting/api_forecasting.py>`_
* `Forecasting using cgru <https://github.com/aimclub/FEDOT/blob/master/examples/simple/time_series_forecasting/cgru.py>`_
* `Fitted values <https://github.com/aimclub/FEDOT/blob/master/examples/simple/time_series_forecasting/fitted_values.py>`_
* `Time-series gap-filling <https://github.com/aimclub/FEDOT/blob/master/examples/simple/time_series_forecasting/gapfilling.py>`_
* `Pipeline tuning for time-series forecasting <https://github.com/aimclub/FEDOT/blob/master/examples/simple/time_series_forecasting/tuning_pipelines.py>`_

**Advanced**

* `Composing ts pipelines with composer <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/time_series_forecasting/composing_pipelines.py>`_
* `Forecasting with using exogenous features <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/time_series_forecasting/exogenous.py>`_
* `Out-of-sample forecasting <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/time_series_forecasting/multistep.py>`_
* `Tuning pipelines with sparse_lagged / lagged node <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/time_series_forecasting/sparse_lagged_tuning.py>`_
* `Topaz multi time-series forecasting <https://github.com/nccr-itmo/FEDOT/blob/master/examples/advanced/time_series_forecasting/multi_ts_arctic_forecasting.py>`_
* `Composing ts pipelines with composer <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/time_series_forecasting/composing_pipelines.py>`_
* `Forecasting with using exogenous features <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/time_series_forecasting/exogenous.py>`_
* `Out-of-sample forecasting <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/time_series_forecasting/multistep.py>`_
* `Tuning pipelines with sparse_lagged / lagged node <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/time_series_forecasting/sparse_lagged_tuning.py>`_
* `Topaz multi time-series forecasting <https://github.com/aimclub/FEDOT/blob/master/examples/advanced/time_series_forecasting/multi_ts_arctic_forecasting.py>`_

**Cases**

* `Case: river level forecasting with composer <https://github.com/nccr-itmo/FEDOT/blob/master/cases/river_levels_prediction/river_level_case_composer.py>`_
* `Case: river level forecasting (manual) <https://github.com/nccr-itmo/FEDOT/blob/master/cases/river_levels_prediction/river_level_case_manual.py>`_
* `Case: river level forecasting with composer <https://github.com/aimclub/FEDOT/blob/master/cases/river_levels_prediction/river_level_case_composer.py>`_
* `Case: river level forecasting (manual) <https://github.com/aimclub/FEDOT/blob/master/cases/river_levels_prediction/river_level_case_manual.py>`_
20 changes: 10 additions & 10 deletions docs/source/contribution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ How to contribute
=================

We welcome you to `check the existing
issues <https://github.com/nccr-itmo/FEDOT/issues>`__ for bugs or
issues <https://github.com/aimclub/FEDOT/issues>`__ for bugs or
enhancements to work on. If you have an idea for an extension to FEDOT,
please `file a new
issue <https://github.com/nccr-itmo/FEDOT/issues/new>`__ so we can
issue <https://github.com/aimclub/FEDOT/issues/new>`__ so we can
discuss it.

Make sure to familiarize yourself with the project layout before making
Expand All @@ -23,9 +23,9 @@ How to contribute
-----------------

The preferred way to contribute to FEDOT is to fork the `main
repository <https://github.com/nccr-itmo/FEDOT/>`__ on GitHub:
repository <https://github.com/aimclub/FEDOT/>`__ on GitHub:

1. Fork the `project repository <https://github.com/nccr-itmo/FEDOT>`__:
1. Fork the `project repository <https://github.com/aimclub/FEDOT>`__:
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.

Expand Down Expand Up @@ -91,17 +91,17 @@ necessary so we can efficiently review and accept your changes.
If your contribution changes FEDOT in any way:

- Update the
`documentation <https://github.com/nccr-itmo/FEDOT/tree/master/docs>`__
`documentation <https://github.com/aimclub/FEDOT/tree/master/docs>`__
so all of your changes are reflected there.

- Update the
`README <https://github.com/nccr-itmo/FEDOT/blob/master/README.md>`__
`README <https://github.com/aimclub/FEDOT/blob/master/README.md>`__
if anything there has changed.

If your contribution involves any code changes:

- Update the `project unit
tests <https://github.com/nccr-itmo/FEDOT/tree/master/test>`__ to
tests <https://github.com/aimclub/FEDOT/tree/master/test>`__ to
test your code changes.

- Make sure that your code is properly commented with
Expand All @@ -117,7 +117,7 @@ If your contribution requires a new library dependency:
changes because we want to keep FEDOT easy to install.

- Add the required version of the library to
`requirements.txt <https://github.com/nccr-itmo/FEDOT/blob/master/requirements.txt>`__
`requirements.txt <https://github.com/aimclub/FEDOT/blob/master/requirements.txt>`__

Contribute to the documentation
-------------------------------
Expand All @@ -128,7 +128,7 @@ automodule:: <module_name> section which describes all the code in the module.

- If a new package with several scripts:

1. Go to `docs/source/api <https://github.com/nccr-itmo/FEDOT/tree/master/docs/source/api>`__ and create new your_name_for_file.rst file.
1. Go to `docs/source/api <https://github.com/aimclub/FEDOT/tree/master/docs/source/api>`__ and create new your_name_for_file.rst file.

2. Add a Header underlined with “=” sign. It’s crucial.

Expand All @@ -150,7 +150,7 @@ automodule:: <module_name> section which describes all the code in the module.

- If a new module to the existed package:

Most of the sections are already described in `docs/source/api <https://github.com/nccr-itmo/FEDOT/tree/master/docs/source/api>`__ , so you can:
Most of the sections are already described in `docs/source/api <https://github.com/aimclub/FEDOT/tree/master/docs/source/api>`__ , 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.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/faq/api_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ Why *feature_name* is not supported?

.. List of links:
.. _pull request: https://github.com/nccr-itmo/FEDOT/pulls
.. _pull request: https://github.com/aimclub/FEDOT/pulls
.. `pull request` replace:: *pull request*
.. _issue: https://github.com/nccr-itmo/FEDOT/issues
.. _issue: https://github.com/aimclub/FEDOT/issues
.. `issue` replace:: *issue*
Can I change path to cacher's database files?
Expand Down
2 changes: 1 addition & 1 deletion docs/source/faq/features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Which algorithms are available as building block for optimiser?

The names and metadata of available ML models can be obtained from
`JSON <https://github.com/aimclub/FEDOT/blob/master/fedot/core/repository/data/model_repository.json>`__ file,
as well as `data operations <https://github.com/nccr-itmo/FEDOT/blob/master/fedot/core/repository/data/data_operation_repository.json>`__ file.
as well as `data operations <https://github.com/aimclub/FEDOT/blob/master/fedot/core/repository/data/data_operation_repository.json>`__ file.

What hyperparameter options were available to each algorithm?
-------------------------------------------------------------
Expand Down
8 changes: 3 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
Welcome to FEDOT's documentation!
=================================

This site contains main documentation for the `FEDOT framework <https://github.com/nccr-itmo/FEDOT>`__.
This site contains main documentation for the `FEDOT framework <https://github.com/aimclub/FEDOT>`__.

The additional description of the algorthmic core, real-world cases and other details is available in `FEDOT.Docs <https://itmo-nss-team.github.io/FEDOT.Miscellaneous>`__.

Fedot is a framework for automated modelling and machine learning, aimed to create the complex composite models that allow obtaining the efficient solution of various applied problems.
FEDOT is a framework for automated modelling and machine learning, aimed to create the complex composite models that allow obtaining the efficient solution of various applied problems.

The introductionary video about Fedot is available here:

Expand All @@ -14,7 +12,7 @@ The introductionary video about Fedot is available here:
:target: http://www.youtube.com/watch?v=RjbuV6i6de4
:alt: Introducing Fedot

The main aim of the Fedot - to improve the quality of analysis of various natural, technical, and social processes by the automated identification of the composite models from available data sets.
The main aim of the FEDOT - to improve the quality of analysis of various natural, technical, and social processes by the automated identification of the composite models from available data sets.


Content
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The GitHub way

.. code-block::
$ git clone https://github.com/nccr-itmo/FEDOT.git
$ git clone https://github.com/aimclub/FEDOT.git
$ cd FEDOT
- **Step 2**. *Creating VirtualEnv*.
Expand Down
2 changes: 1 addition & 1 deletion fedot/preprocessing/preprocessing.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ def __init__(self):
def __setstate__(self, state):
# Implemented for backward compatibility for unpickling
# Pipelines with older preprocessor that had DiGraph with Nodes inside.
# see https://github.com/nccr-itmo/FEDOT/pull/802
# see https://github.com/aimclub/FEDOT/pull/802
unrelevant_fields = ['structure_analysis']
for field in unrelevant_fields:
if field in state:
Expand Down

0 comments on commit 3f794c0

Please sign in to comment.