Skip to content
Snippets Groups Projects
Commit 748204b7 authored by Cyril Moineau's avatar Cyril Moineau
Browse files

[Docs] Add documentation skeleton.

parent 1cbbd27d
No related branches found
No related tags found
No related merge requests found
......@@ -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',
......
Data
====
C++ API for tensor class :
.. doxygenclass:: Aidge::Tensor
Aidge C++ API
=============
.. toctree::
data.rst
\ No newline at end of file
Aidge Python API
================
.. toctree::
Aidge API
=========
.. toctree::
Cpp/index.rst
Python/index.rst
\ No newline at end of file
Tutorials
=========
Incoming ...
\ No newline at end of file
Overview of the Aidge Framework
===============================
Get Started
===========
.. toctree::
:maxdepth: 2
install.rst
quickStart.rst
\ No newline at end of file
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
Quick Start
===========
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
File moved
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
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment