Add changes for e69bba2

janelia-cellmap · Nov 13, 2024 · e179c9e · e179c9e
1 parent 2a4bf0e
commit e179c9e
Show file tree

Hide file tree

Showing 221 changed files with 8,081 additions and 6,429 deletions.
diff --git a/_images/2ccbe1c4a7d98ed745fcc7f7200daca047854f04cb1737136d0783ead59094b0.png b/_images/2ccbe1c4a7d98ed745fcc7f7200daca047854f04cb1737136d0783ead59094b0.png
diff --git a/_images/4591dcf10cb139f8367afafe250d25785713675cc5c45038343818c91d8e1c7e.png b/_images/4591dcf10cb139f8367afafe250d25785713675cc5c45038343818c91d8e1c7e.png
diff --git a/_images/740324669767434e3255abbf72201f026346cb4364f2e6f09e376c501f4c34ea.png b/_images/740324669767434e3255abbf72201f026346cb4364f2e6f09e376c501f4c34ea.png
diff --git a/_images/8b95fb5e10d8585878ac2263174f153a8896787b2e7c482e18dca9dd22d661ac.png b/_images/8b95fb5e10d8585878ac2263174f153a8896787b2e7c482e18dca9dd22d661ac.png
diff --git a/_images/8be921556f6acfaaec95b290e4988697111466d547af287c05c75c5e4b1f0218.png b/_images/8be921556f6acfaaec95b290e4988697111466d547af287c05c75c5e4b1f0218.png
diff --git a/_images/a95cc34aa288a713aa4e8ae662e6e2b4bf1df92956d2bd22f906bedc9ad0bab2.png b/_images/a95cc34aa288a713aa4e8ae662e6e2b4bf1df92956d2bd22f906bedc9ad0bab2.png
diff --git a/_images/b40d3b8736f7145a8fdedb807170b2db4c6419fca7875f53015de0dbcc6cdd50.png b/_images/b40d3b8736f7145a8fdedb807170b2db4c6419fca7875f53015de0dbcc6cdd50.png
diff --git a/_images/c9c4bfe23fa7ad56740e5169aef51a8491920f9509173a32aed236d520ba90c2.png b/_images/c9c4bfe23fa7ad56740e5169aef51a8491920f9509173a32aed236d520ba90c2.png
diff --git a/_sources/autoapi/dacapo/experiments/datasplits/datasets/index.rst.txt b/_sources/autoapi/dacapo/experiments/datasplits/datasets/index.rst.txt
@@ -18,6 +18,7 @@ Submodules
    /autoapi/dacapo/experiments/datasplits/datasets/graphstores/index
    /autoapi/dacapo/experiments/datasplits/datasets/raw_gt_dataset/index
    /autoapi/dacapo/experiments/datasplits/datasets/raw_gt_dataset_config/index
+   /autoapi/dacapo/experiments/datasplits/datasets/simple/index
 
 
 Classes
@@ -31,6 +32,7 @@ Classes
    dacapo.experiments.datasplits.datasets.DummyDatasetConfig
    dacapo.experiments.datasplits.datasets.RawGTDataset
    dacapo.experiments.datasplits.datasets.RawGTDatasetConfig
+   dacapo.experiments.datasplits.datasets.SimpleDataset
 
 
 Package Contents
@@ -409,3 +411,80 @@ Package Contents
       :type:  Optional[List[funlib.geometry.Coordinate]]
 
 
+.. py:class:: SimpleDataset
+
+
+
+   A class used to define configuration for datasets. This provides the
+   framework to create a Dataset instance.
+
+   .. attribute:: name
+
+      str (eg: "sample_dataset").
+      A unique identifier to name the dataset.
+      It aids in easy identification and reusability of this dataset.
+      Advised to keep it short and refrain from using special characters.
+
+   .. attribute:: weight
+
+      int (default=1).
+      A numeric value that indicates how frequently this dataset should be
+      sampled in comparison to others. Higher the weight, more frequently it
+      gets sampled.
+
+   .. method:: verify
+
+
+      Checks and validates the dataset configuration. The specific rules for
+      validation need to be defined by the user.
+
+   .. rubric:: Notes
+
+   This class is used to create a configuration object for datasets.
+
+
+   .. py:attribute:: path
+      :type:  pathlib.Path
+
+
+   .. py:attribute:: weight
+      :type:  int
+
+
+   .. py:attribute:: raw_name
+      :type:  str
+
+
+   .. py:attribute:: gt_name
+      :type:  str
+
+
+   .. py:attribute:: mask_name
+      :type:  str
+
+
+   .. py:method:: dataset_type(dataset_config)
+      :staticmethod:
+
+
+
+   .. py:property:: raw
+      :type: funlib.persistence.Array
+
+
+
+   .. py:property:: gt
+      :type: funlib.persistence.Array
+
+
+
+   .. py:property:: mask
+      :type: funlib.persistence.Array | None
+
+
+
+   .. py:property:: sample_points
+      :type: None
+
+
+
diff --git a/_sources/autoapi/dacapo/experiments/datasplits/datasets/simple/index.rst.txt b/_sources/autoapi/dacapo/experiments/datasplits/datasets/simple/index.rst.txt
@@ -0,0 +1,94 @@
+dacapo.experiments.datasplits.datasets.simple
+=============================================
+
+.. py:module:: dacapo.experiments.datasplits.datasets.simple
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   dacapo.experiments.datasplits.datasets.simple.SimpleDataset
+
+
+Module Contents
+---------------
+
+.. py:class:: SimpleDataset
+
+
+
+   A class used to define configuration for datasets. This provides the
+   framework to create a Dataset instance.
+
+   .. attribute:: name
+
+      str (eg: "sample_dataset").
+      A unique identifier to name the dataset.
+      It aids in easy identification and reusability of this dataset.
+      Advised to keep it short and refrain from using special characters.
+
+   .. attribute:: weight
+
+      int (default=1).
+      A numeric value that indicates how frequently this dataset should be
+      sampled in comparison to others. Higher the weight, more frequently it
+      gets sampled.
+
+   .. method:: verify
+
+
+      Checks and validates the dataset configuration. The specific rules for
+      validation need to be defined by the user.
+
+   .. rubric:: Notes
+
+   This class is used to create a configuration object for datasets.
+
+
+   .. py:attribute:: path
+      :type:  pathlib.Path
+
+
+   .. py:attribute:: weight
+      :type:  int
+
+
+   .. py:attribute:: raw_name
+      :type:  str
+
+
+   .. py:attribute:: gt_name
+      :type:  str
+
+
+   .. py:attribute:: mask_name
+      :type:  str
+
+
+   .. py:method:: dataset_type(dataset_config)
+      :staticmethod:
+
+
+
+   .. py:property:: raw
+      :type: funlib.persistence.Array
+
+
+
+   .. py:property:: gt
+      :type: funlib.persistence.Array
+
+
+
+   .. py:property:: mask
+      :type: funlib.persistence.Array | None
+
+
+
+   .. py:property:: sample_points
+      :type: None
+
+
+
diff --git a/_sources/autoapi/dacapo/experiments/datasplits/index.rst.txt b/_sources/autoapi/dacapo/experiments/datasplits/index.rst.txt
@@ -17,6 +17,7 @@ Submodules
    /autoapi/dacapo/experiments/datasplits/dummy_datasplit/index
    /autoapi/dacapo/experiments/datasplits/dummy_datasplit_config/index
    /autoapi/dacapo/experiments/datasplits/keys/index
+   /autoapi/dacapo/experiments/datasplits/simple_config/index
    /autoapi/dacapo/experiments/datasplits/train_validate_datasplit/index
    /autoapi/dacapo/experiments/datasplits/train_validate_datasplit_config/index
 
@@ -34,6 +35,7 @@ Classes
    dacapo.experiments.datasplits.TrainValidateDataSplitConfig
    dacapo.experiments.datasplits.DataSplitGenerator
    dacapo.experiments.datasplits.DatasetSpec
+   dacapo.experiments.datasplits.SimpleDataSplitConfig
 
 
 Package Contents
@@ -667,3 +669,57 @@ Package Contents
    .. py:attribute:: gt_dataset
 
 
+.. py:class:: SimpleDataSplitConfig
+
+
+
+   A convention over configuration datasplit that can handle many of the most
+   basic cases.
+
+
+   .. py:attribute:: path
+      :type:  pathlib.Path
+
+
+   .. py:attribute:: name
+      :type:  str
+
+
+   .. py:attribute:: train_group_name
+      :type:  str
+
+
+   .. py:attribute:: validate_group_name
+      :type:  str
+
+
+   .. py:attribute:: raw_name
+      :type:  str
+
+
+   .. py:attribute:: gt_name
+      :type:  str
+
+
+   .. py:attribute:: mask_name
+      :type:  str
+
+
+   .. py:method:: datasplit_type(datasplit_config)
+      :staticmethod:
+
+
+
+   .. py:method:: get_paths(group_name: str) -> list[pathlib.Path]
+
+
+   .. py:property:: train
+      :type: list[dacapo.experiments.datasplits.datasets.simple.SimpleDataset]
+
+
+
+   .. py:property:: validate
+      :type: list[dacapo.experiments.datasplits.datasets.simple.SimpleDataset]
+
+
+
diff --git a/_sources/autoapi/dacapo/experiments/datasplits/simple_config/index.rst.txt b/_sources/autoapi/dacapo/experiments/datasplits/simple_config/index.rst.txt
@@ -0,0 +1,71 @@
+dacapo.experiments.datasplits.simple_config
+===========================================
+
+.. py:module:: dacapo.experiments.datasplits.simple_config
+
+
+Classes
+-------
+
+.. autoapisummary::
+
+   dacapo.experiments.datasplits.simple_config.SimpleDataSplitConfig
+
+
+Module Contents
+---------------
+
+.. py:class:: SimpleDataSplitConfig
+
+
+
+   A convention over configuration datasplit that can handle many of the most
+   basic cases.
+
+
+   .. py:attribute:: path
+      :type:  pathlib.Path
+
+
+   .. py:attribute:: name
+      :type:  str
+
+
+   .. py:attribute:: train_group_name
+      :type:  str
+
+
+   .. py:attribute:: validate_group_name
+      :type:  str
+
+
+   .. py:attribute:: raw_name
+      :type:  str
+
+
+   .. py:attribute:: gt_name
+      :type:  str
+
+
+   .. py:attribute:: mask_name
+      :type:  str
+
+
+   .. py:method:: datasplit_type(datasplit_config)
+      :staticmethod:
+
+
+
+   .. py:method:: get_paths(group_name: str) -> list[pathlib.Path]
+
+
+   .. py:property:: train
+      :type: list[dacapo.experiments.datasplits.datasets.simple.SimpleDataset]
+
+
+
+   .. py:property:: validate
+      :type: list[dacapo.experiments.datasplits.datasets.simple.SimpleDataset]
+
+
+