larvaworld.portal.datasets.models
=================================

.. py:module:: larvaworld.portal.datasets.models


Attributes
----------

.. autoapisummary::

   larvaworld.portal.datasets.models.WorkspaceReplayDatasetOrigin


Classes
-------

.. autoapisummary::

   larvaworld.portal.datasets.models.WorkspaceDatasetRecord
   larvaworld.portal.datasets.models.WorkspaceReplayDatasetRecord
   larvaworld.portal.datasets.models.ImportRequest


Module Contents
---------------

.. py:class:: WorkspaceDatasetRecord

   .. py:attribute:: dataset_id
      :type:  str


   .. py:attribute:: dataset_dir
      :type:  pathlib.Path


   .. py:attribute:: data_dir
      :type:  pathlib.Path


   .. py:attribute:: conf_path
      :type:  pathlib.Path


   .. py:attribute:: h5_path
      :type:  pathlib.Path


   .. py:attribute:: lab_id
      :type:  str | None


   .. py:attribute:: group_id
      :type:  str | None


   .. py:attribute:: ref_id
      :type:  str | None


   .. py:attribute:: n_agents
      :type:  int | None


.. py:data:: WorkspaceReplayDatasetOrigin

.. py:class:: WorkspaceReplayDatasetRecord

   .. py:attribute:: origin
      :type:  WorkspaceReplayDatasetOrigin


   .. py:attribute:: dataset_id
      :type:  str


   .. py:attribute:: dataset_dir
      :type:  pathlib.Path


   .. py:attribute:: data_dir
      :type:  pathlib.Path


   .. py:attribute:: conf_path
      :type:  pathlib.Path


   .. py:attribute:: h5_path
      :type:  pathlib.Path


   .. py:attribute:: group_id
      :type:  str | None


   .. py:attribute:: run_id
      :type:  str | None


   .. py:attribute:: member_id
      :type:  str | None


   .. py:attribute:: ref_id
      :type:  str | None


   .. py:attribute:: n_agents
      :type:  int | None


.. py:class:: ImportRequest

   .. py:attribute:: lab_id
      :type:  str


   .. py:attribute:: parent_dir
      :type:  str


   .. py:attribute:: raw_folder
      :type:  pathlib.Path | None
      :value: None



   .. py:attribute:: group_id
      :type:  str | None
      :value: None



   .. py:attribute:: dataset_id
      :type:  str | None
      :value: None



   .. py:attribute:: merged
      :type:  bool
      :value: False



   .. py:attribute:: color
      :type:  str
      :value: 'black'



   .. py:attribute:: ref_id
      :type:  str | None
      :value: None



   .. py:attribute:: enrich_conf
      :type:  dict[str, object] | None
      :value: None



   .. py:attribute:: extra_kwargs
      :type:  dict[str, object]