diff --git a/docs/experiments.rst b/docs/experiments.rst deleted file mode 100644 index eadc650..0000000 --- a/docs/experiments.rst +++ /dev/null @@ -1,4 +0,0 @@ -Running Experiments --------------------- - -Under construction... \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index d1dfeae..b5c358c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,8 +12,6 @@ Welcome to Minerva's documentation! installation tutorials - experiments - contributing api diff --git a/docs/installation.rst b/docs/installation.rst index 88d3618..17dfdc8 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -1,4 +1,15 @@ -Installation ------------------ +.. _installation: + +========================== +Installation Guide +========================== + +Pip Installation +--------------------- + +To install Minerva, you can use pip: + +.. code-block:: bash + + pip install minerva -Under construction... \ No newline at end of file diff --git a/docs/notebooks/1.datasets.ipynb b/docs/notebooks/1.datasets.ipynb index 9ae5b10..3184776 100644 --- a/docs/notebooks/1.datasets.ipynb +++ b/docs/notebooks/1.datasets.ipynb @@ -119,6 +119,13 @@ "\n", "This structured approach ensures clarity and flexibility in handling different tasks and data organizations." ] + }, + { + "cell_type": "markdown", + "metadata": {}, + "source": [ + "![Figure Title](figures/dataset_readers.svg)" + ] } ], "metadata": { diff --git a/docs/notebooks/figures/dataset_readers.svg b/docs/notebooks/figures/dataset_readers.svg new file mode 100644 index 0000000..99c48bc --- /dev/null +++ b/docs/notebooks/figures/dataset_readers.svg @@ -0,0 +1,4 @@ + + + +
5
4
3
Data Module
2
TiffReader

Data Organization

Data unit: Each unit of data is a file inside root folder, suffixed with *tif or *.tiff
Order: Lexigraphical order

Example:
root/
0.tiff
1.tiff
...

PNGReader

Data Organization

Data unit: Each unit of data is a file inside root folder, suffixed with *png
Order: Lexigraphical order

Example:
root/
0.png
1.png
...

PatchedZarrReader

Data Organization

Data unit: Given a n-dimensional zarr array, and data_shape, each unit of data is a sub array with size data_shape.
Order: First dim, second dim, ....
1
0

0.png

1.png

2.png

0.tiff

1.tiff

2.tiff
SimpleSupervisedDataset
PatchedZarrReader
(original.zarr)
PatchedZarrReader
(envelope.zarr)
Transforms Set A
Transforms Set B
__getitem__(index)
(A, B)
train_dataloader()
 \ No newline at end of file diff --git a/docs/tutorials.rst b/docs/tutorials.rst index 2edd48a..d82c0a9 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -7,4 +7,4 @@ Tutorials .. toctree:: :maxdepth: 2 - Under construction \ No newline at end of file + notebooks/1.datasets.ipynb \ No newline at end of file