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

[Docs] Add GetStarted example and Python API example.

parent cee31c9c
No related branches found
No related tags found
No related merge requests found
...@@ -9,6 +9,7 @@ install*/ ...@@ -9,6 +9,7 @@ install*/
*.so *.so
__pycache__ __pycache__
*.pyc *.pyc
*.egg-info
# Mermaid # Mermaid
*.mmd *.mmd
......
...@@ -4,4 +4,5 @@ Aidge C++ API ...@@ -4,4 +4,5 @@ Aidge C++ API
.. toctree:: .. toctree::
data.rst data.rst
\ No newline at end of file op.md
\ No newline at end of file
Data
====
Python API for tensor class:
.. autoclass:: aidge.Tensor
\ No newline at end of file
...@@ -4,3 +4,4 @@ Aidge Python API ...@@ -4,3 +4,4 @@ Aidge Python API
.. toctree:: .. toctree::
data.rst
\ No newline at end of file
Overview of the Aidge Framework Overview of the Aidge Framework
=============================== ===============================
Context
-------
...@@ -2,3 +2,24 @@ Quick Start ...@@ -2,3 +2,24 @@ Quick Start
=========== ===========
Fake example of quck start TODO fill this section ...
.. tab-set::
.. tab-item:: Python
To instanciate a tensor you can use :py:class:`aidge.Tensor`:
.. code-block:: Python
aidge.Tensor()
.. tab-item:: C++
To instanciate a tensor you can use :cpp:class:`Aidge::Tensor`:
.. code-block:: C++
Aidge::Tensor()
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