deploy: ad3a4b9

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 2b0f7bc2ccf74387f3d2544eb276696e
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/api/core.rst.txt

@@ -0,0 +1,64 @@
+CORE
+====
+
+.. list-table::
+    :header-rows: 1
+    :width: 80%
+    :widths: 15 15 15 15
+
+    * - :doc:`core/asyncsocket`
+      - :doc:`core/dataset`
+      - :doc:`core/environment`
+      - :doc:`core/manager`
+
+    * - | :ref:`asyncsocket.bytesconverter`
+        | :ref:`asyncsocket.tcpipclient`
+        | :ref:`asyncsocket.tcpipobject`
+        | :ref:`asyncsocket.tcpipserver`
+
+      - | :ref:`database.databasehandler`
+        | :ref:`database.basedatabaseconfig`
+
+      - | :ref:`environment.baseenvironment`
+        | :ref:`environment.baseenvironmentconfig`
+
+      - | :ref:`manager.datamanager`
+        | :ref:`manager.databasemanager`
+        | :ref:`manager.environmentmanager`
+        | :ref:`manager.networkmanager`
+        | :ref:`manager.statsmanager`
+
+
+.. list-table::
+    :header-rows: 1
+    :width: 60%
+    :widths: 15 15 15
+
+    * - :doc:`core/network`
+      - :doc:`core/pipeline`
+      - :doc:`core/visualizer`
+
+    * - | :ref:`network.basenetwork`
+        | :ref:`network.basenetworkconfig`
+        | :ref:`network.baseoptimization`
+        | :ref:`network.datatransformation`
+
+      - | :ref:`pipelines.basedatageneration`
+        | :ref:`pipelines.basepipeline`
+        | :ref:`pipelines.baseprediction`
+        | :ref:`pipelines.basetraining`
+
+      - | :ref:`visualizer.vedofactory`
+        | :ref:`visualizer.vedovisualizer`
+
+
+.. toctree::
+    :hidden:
+
+    AsyncSocket  <core/asyncsocket.rst>
+    Dataset      <core/dataset.rst>
+    Environment  <core/environment.rst>
+    Manager      <core/manager.rst>
+    Network      <core/network.rst>
+    Pipelines    <core/pipeline.rst>
+    Visualizer   <core/visualizer.rst>

_sources/api/core/asyncsocket.rst.txt

@@ -0,0 +1,43 @@
+AsyncSocket
+===========
+
+.. _asyncsocket.bytesconverter:
+
+BytesConverter
+______________
+
+.. autoclass:: BytesConverter.BytesConverter
+    :members:
+
+.. _asyncsocket.tcpipclient:
+
+TcpIpClient
+___________
+
+Bases:
+:py:class:`TcpIpObject.TcpIpObject`
+
+.. autoclass:: TcpIpClient.TcpIpClient
+    :members:
+    :private-members:
+
+.. _asyncsocket.tcpipobject:
+
+TcpIpObject
+___________
+
+.. autoclass:: TcpIpObject.TcpIpObject
+    :members:
+    :private-members:
+
+.. _asyncsocket.tcpipserver:
+
+TcpIpServer
+___________
+
+Base:
+:py:class:`TcpIpObject.TcpIpObject`
+
+.. autoclass:: TcpIpServer.TcpIpServer
+    :members:
+    :private-members:

_sources/api/core/dataset.rst.txt

@@ -0,0 +1,18 @@
+Dataset
+=======
+
+.. _database.databasehandler:
+
+DatabaseHandler
+---------------
+
+.. autoclass:: DatabaseHandler.DatabaseHandler
+    :members:
+
+.. _database.basedatabaseconfig:
+
+BaseDatabaseConfig
+------------------
+
+.. autoclass:: BaseDatabaseConfig.BaseDatabaseConfig
+    :members:

_sources/api/core/environment.rst.txt

@@ -0,0 +1,17 @@
+Environment
+===========
+
+.. _environment.baseenvironment:
+
+BaseEnvironment
+---------------
+
+.. autoclass:: BaseEnvironment.BaseEnvironment
+    :members:
+
+.. _environment.baseenvironmentconfig:
+
+BaseEnvironmentConfig
+---------------------
+.. autoclass:: BaseEnvironmentConfig.BaseEnvironmentConfig
+    :members:

_sources/api/core/manager.rst.txt

@@ -0,0 +1,42 @@
+Manager
+=======
+
+.. _manager.datamanager:
+
+DataManager
+-----------
+
+.. autoclass:: DataManager.DataManager
+    :members:
+
+.. _manager.databasemanager:
+
+DatabaseManager
+---------------
+
+.. autoclass:: DatabaseManager.DatabaseManager
+    :members:
+
+.. _manager.environmentmanager:
+
+EnvironmentManager
+------------------
+
+.. autoclass:: EnvironmentManager.EnvironmentManager
+    :members:
+
+.. _manager.networkmanager:
+
+NetworkManager
+--------------
+
+.. autoclass:: NetworkManager.NetworkManager
+    :members:
+
+.. _manager.statsmanager:
+
+StatsManager
+------------
+
+.. autoclass:: StatsManager.StatsManager
+    :members:

_sources/api/core/network.rst.txt

@@ -0,0 +1,34 @@
+Network
+=======
+
+.. _network.basenetwork:
+
+BaseNetwork
+-----------
+
+.. autoclass:: BaseNetwork.BaseNetwork
+    :members:
+
+.. _network.basenetworkconfig:
+
+BaseNetworkConfig
+-----------------
+
+.. autoclass:: BaseNetworkConfig.BaseNetworkConfig
+    :members:
+
+.. _network.baseoptimization:
+
+BaseOptimization
+----------------
+
+.. autoclass:: BaseOptimization.BaseOptimization
+    :members:
+
+.. _network.datatransformation:
+
+DataTransformation
+------------------
+
+.. autoclass:: BaseTransformation.BaseTransformation
+    :members:

_sources/api/core/pipeline.rst.txt

@@ -0,0 +1,43 @@
+Pipelines
+=========
+
+.. _pipelines.basedatageneration:
+
+BaseDataGeneration
+------------------
+
+Bases:
+:py:class:`BasePipeline.BasePipeline`
+
+.. autoclass:: BaseDataGeneration.BaseDataGeneration
+    :members:
+
+.. _pipelines.basepipeline:
+
+BasePipeline
+------------
+
+.. autoclass:: BasePipeline.BasePipeline
+    :members:
+
+.. _pipelines.baseprediction:
+
+BasePrediction
+--------------
+
+Bases:
+:py:class:`BasePipeline.BasePipeline`
+
+.. autoclass:: BasePrediction.BasePrediction
+    :members:
+
+.. _pipelines.basetraining:
+
+BaseTrainer
+-----------
+
+Bases:
+:py:class:`BasePipeline.BasePipeline`
+
+.. autoclass:: BaseTraining.BaseTraining
+    :members:

_sources/api/core/visualizer.rst.txt

@@ -0,0 +1,22 @@
+Visualizer
+==========
+
+.. _visualizer.vedofactory:
+
+VedoFactory
+-----------
+
+.. autoclass:: VedoFactory.VedoFactory
+    :members:
+
+.. _visualizer.vedovisualizer:
+
+VedoVisualizer
+--------------
+
+.. autoclass:: VedoVisualizer.VedoVisualizer
+    :members:
+
+
+
+

_sources/api/sofa.rst.txt

@@ -0,0 +1,4 @@
+SOFA
+====
+
+Find **DeepPhysX.Sofa** API `here <https://deepphysx-sofa.readthedocs.io>`_

_sources/api/torch.rst.txt

@@ -0,0 +1,4 @@
+TORCH
+=====
+
+Find **DeepPhysX.Torch** API `here <https://deepphysx-torch.readthedocs.io>`_.

_sources/component/dataset.rst.txt

@@ -0,0 +1,76 @@
+CORE - Using a Dataset
+======================
+
+Dedicated code in :guilabel:`Core/Dataset` module.
+
+Behavior
+--------
+
+**DeepPhysX** comes with its own *Dataset* management system, using the features from the :SSD:`SSD <>` library.
+The synthetic data produced in *Environments* is stored on a *Database* that is in a dedicated repository named
+``dataset`` in the training session.
+Data is stored as partitions: these partitions correspond to the different *Dataset* modes (training data, test data,
+prediction data) and can be multiple for each data field in order not to exceed the maximum size of the current amount
+of loaded data.
+Each partition will have a unique name: ``<session_name>_<dataset_mode>_<field>_<index>.npy``.
+
+.. figure:: ../_static/image/database.png
+    :alt: database.png
+    :align: center
+    :width: 80%
+
+    Dataset repository organisation.
+
+When adding a batch to the *Dataset*, a new partition is created for each data field if the current *Dataset* size
+exceeds the threshold.
+The batch is then appended to the *Dataset* for each data field.
+Default *Dataset* fields are inputs and outputs, but users can define any data field from *Environment*
+(see :ref:`dedicated section <environment-implementation>`).
+Each field must always be filled at each batch.
+A ``dataset.json`` file gathers information about the produced dataset and normalization coefficients if the
+normalization is applied.
+
+When loading data from an existing *Dataset*, the partitions are loaded and can be accessed randomly or not among the
+whole set of partitions.
+
+
+Configuration
+-------------
+
+A *Dataset* is almost always used in DeepPhysX pipelines and requires a *DatasetConfig*.
+This *Configuration* object role is to bring together all the options to configure the *Dataset* and to create it with
+``create_dataset`` method.
+
+Here is a description of attributes related to *Dataset* configuration.
+
+.. list-table::
+    :width: 100%
+    :widths: 15 85
+
+    * - ``existing_dir``
+      - Path to an existing *Dataset* repository if this repository needs to be loaded or completed.
+
+    * - ``max_file_size``
+      - Maximum size (in Gb) of the total *Dataset* object.
+
+    * - ``mode``
+      - Specify the *Dataset* mode between "Training", "Validation" and "Running".
+
+    * - ``normalize``
+      - If True, normalization parameters are computed from training data and applied to any loaded data.
+
+    * - ``shuffle``
+      - Specify if the loading order is random or not (True by default).
+
+.. highlight:: python
+
+See following example::
+
+    # Import DatasetConfig
+    from DeepPhysX_Core.Database.BaseDatabaseConfig import BaseDatabaseConfig
+
+    # Create the config
+    database_config = BaseDatabaseConfig(max_file_size=1,
+                                         shuffle=True,
+                                         mode='Training',
+                                         normalize=True)