diff --git a/docs/conf.py b/docs/conf.py index fb3fdbdeb5f956930c6310d9de088fb7e3572400..87c1fd165c86d43782974ecf52894b3ee1b1d844 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -65,7 +65,6 @@ extensions = [ 'sphinx_copybutton' ] -bibtex_bibfiles = ['_static/refs.bib'] graphviz_output_format = 'svg' # Mermaid Configuration @@ -193,7 +192,9 @@ html_context = { # 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'] +html_static_path = ['source/_static'] + +bibtex_bibfiles = [html_static_path[0] + '/refs.bib'] html_css_files = [ 'css/custom.css', diff --git a/docs/source/API/Cpp/data.rst b/docs/source/API/Cpp/data.rst new file mode 100644 index 0000000000000000000000000000000000000000..bd4e6337cf5cc58293e569adc73ef644e6dcd029 --- /dev/null +++ b/docs/source/API/Cpp/data.rst @@ -0,0 +1,6 @@ +Data +==== + +C++ API for tensor class : + +.. doxygenclass:: Aidge::Tensor diff --git a/docs/source/API/Cpp/index.rst b/docs/source/API/Cpp/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..80be0326635fcdebf80dccc7cd00865d3604a4fb --- /dev/null +++ b/docs/source/API/Cpp/index.rst @@ -0,0 +1,7 @@ +Aidge C++ API +============= + + +.. toctree:: + + data.rst \ No newline at end of file diff --git a/docs/source/API/Python/index.rst b/docs/source/API/Python/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..7dae8ae0e88cc1d1e8e74285e212d94a5d8a4572 --- /dev/null +++ b/docs/source/API/Python/index.rst @@ -0,0 +1,6 @@ +Aidge Python API +================ + + +.. toctree:: + diff --git a/docs/source/API/index.rst b/docs/source/API/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..511bb6efd2ee9315fc62be26485e6238d6ab5d89 --- /dev/null +++ b/docs/source/API/index.rst @@ -0,0 +1,7 @@ +Aidge API +========= + +.. toctree:: + + Cpp/index.rst + Python/index.rst \ No newline at end of file diff --git a/docs/source/Tutorial/index.rst b/docs/source/Tutorial/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..cf89cceddd66426175f95e765fd6ef00e45b7b73 --- /dev/null +++ b/docs/source/Tutorial/index.rst @@ -0,0 +1,4 @@ +Tutorials +========= + +Incoming ... \ No newline at end of file diff --git a/docs/source/UserGuide/FrameworkPresentation/index.rst b/docs/source/UserGuide/FrameworkPresentation/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..e030262ff37b8e9dca44f726a9693c43b0f2c6d1 --- /dev/null +++ b/docs/source/UserGuide/FrameworkPresentation/index.rst @@ -0,0 +1,3 @@ +Overview of the Aidge Framework +=============================== + diff --git a/docs/source/UserGuide/GetStarted/index.rst b/docs/source/UserGuide/GetStarted/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..99e2b2ac5fc409cb01f84e9665c24b1f130b23b2 --- /dev/null +++ b/docs/source/UserGuide/GetStarted/index.rst @@ -0,0 +1,8 @@ +Get Started +=========== + +.. toctree:: + :maxdepth: 2 + + install.rst + quickStart.rst \ No newline at end of file diff --git a/docs/source/UserGuide/GetStarted/install.rst b/docs/source/UserGuide/GetStarted/install.rst new file mode 100644 index 0000000000000000000000000000000000000000..66a8d79fa5d783bbdd084270333161b63ecc2e0f --- /dev/null +++ b/docs/source/UserGuide/GetStarted/install.rst @@ -0,0 +1,14 @@ +Install +======= + +Build on Linux +-------------- + +Install Python +^^^^^^^^^^^^^^ + +To build manually Aidge on Linux, go at the root of the project and run in your python environment + +.. code-block:: bash + + pip install . -v diff --git a/docs/source/UserGuide/GetStarted/quickStart.rst b/docs/source/UserGuide/GetStarted/quickStart.rst new file mode 100644 index 0000000000000000000000000000000000000000..4c795453e2cf40f2d71510fa07310f2c6bf1226c --- /dev/null +++ b/docs/source/UserGuide/GetStarted/quickStart.rst @@ -0,0 +1,4 @@ +Quick Start +=========== + + diff --git a/docs/source/UserGuide/index.rst b/docs/source/UserGuide/index.rst new file mode 100644 index 0000000000000000000000000000000000000000..0657a73a36a8cd0c47b677922cc2e1ba43ddaf26 --- /dev/null +++ b/docs/source/UserGuide/index.rst @@ -0,0 +1,15 @@ +User Guide +========== + +.. toctree:: + :maxdepth: 1 + :caption: Framework Presentation + + ./FrameworkPresentation/index.rst + + +.. toctree:: + :maxdepth: 1 + :caption: Get Started + + ./GetStarted/index.rst \ No newline at end of file diff --git a/docs/_static/refs.bib b/docs/source/_static/refs.bib similarity index 100% rename from docs/_static/refs.bib rename to docs/source/_static/refs.bib diff --git a/docs/source/index.rst b/docs/source/index.rst index 0dfdd1b836b34548ff432459c9f49858ac7d233f..1c4d8c71042c873dbcb2e56e18a624f9327b1673 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,3 +1,88 @@ Aidge ===== +:Release: |version| +:Date: |today| + +Aidge is a `CEA LIST <https://list.cea.fr/en/>`_'s deep learning library +optimized for export and processing on embedded devices. + +It allows to create or import a Computational Graph from common Frameworks, apply +editing on its structure, train it and export its architecture on many +embedded devices. It provides optimized functions for inference as +well as training and many custom functionalities for the target device. + +.. grid:: 1 2 2 3 + :margin: 4 4 0 0 + :gutter: 1 + + .. grid-item-card:: :octicon:`desktop-download` Install + :link: UserGuide/GetStarted/install + :link-type: doc + + Find your configuration and requirements. + + .. grid-item-card:: :octicon:`table` Quick Start + :link: UserGuide/GetStarted/quickStart + :link-type: doc + + Build, train and deploy your first network. + + .. grid-item-card:: :octicon:`checklist` General Presentation + :link: UserGuide/FrameworkPresentation/index + :link-type: doc + + The main hub for detailed usage explanations. + + .. grid-item-card:: :octicon:`book` API Reference + :link: API/index + :link-type: doc + + Details every modules, classes and functions. + + .. grid-item-card:: :octicon:`light-bulb` Tutorials + :link: Tutorial/index + :link-type: doc + + Learn by seeing. + + .. grid-item-card:: :octicon:`comment` Exchange forum + :link: https://gitlab.eclipse.org/groups/eclipse/aidge/-/issues + + Exchange with the team and other users over features. + + +What is Aidge ? +--------------- + +Aidge is a direct successor of `N2D2 <https://n2d2.readthedocs.io/en/latest/intro/intro.html>`_, +a solution for fast and accurate Deep Neural Network (DNN) simulation Framework as well +as full and automated DNN-based applications building. + +Aidge keeps the numerous embedded supports that made the strength of N2D2 while +improving or adding many functionalities, among which: + +- A more userfriendly API and documentation. +- | An simpler structure for both the compuational graph and the code, + | making it easier to understand and edit the functions +- A highly customizable plugin system with templates and tutorials to follow +- A light core library +- World-leading, device-dependant, graph optimization functionalities +- Runtime execution on the target device with any of the core functionalities exportable +- Hand on the Scheduler +- Possibility to run a single DNN on heterogeneous targets + + +Licence +------- + +Aidge is released under the Eclipse Public License 2.0 + + +.. toctree:: + :maxdepth: 1 + :hidden: + + API/index.rst + UserGuide/index.rst + Tutorial/index.rst