Clean Up of Existing Documentation (#66)

* Clean up of existing docs * Remove redundant heading * Remove colons * Delete adult.rst * Delete allenai_c4.rst * Delete automl.rst * Delete camvid.rst * Delete cc100.rst * Delete conceptual_captions.rst * Delete datascience_bowl.rst * Delete imagenet.rst * Delete kaggle_casting_quality.rst * Delete monthly_german_tweets.rst
merantix-momentum · Nov 4, 2022 · bb6b499 · bb6b499
1 parent aac8330
commit bb6b499
Show file tree

Hide file tree

Showing 27 changed files with 82 additions and 58 deletions.
diff --git a/docs/dataset_links/adult.rst b/docs/dataset_links/adult.rst
@@ -1,3 +1,3 @@
-Dataset Card - Adult Dataset
+Adult
 =====================================
 .. include:: ../../src/squirrel_datasets_core/datasets/adult_dataset/README.rst
diff --git a/docs/dataset_links/allenai_c4.rst b/docs/dataset_links/allenai_c4.rst
@@ -1,3 +1,3 @@
-Dataset Card - AllenAI C4
+AllenAI C4
 =====================================
 .. include:: ../../src/squirrel_datasets_core/datasets/allenai_c4/README.rst
diff --git a/docs/dataset_links/automl.rst b/docs/dataset_links/automl.rst
@@ -1,3 +1,3 @@
-Dataset Card - AutoML
+AutoML
 =====================================
 .. include:: ../../src/squirrel_datasets_core/datasets/AutoML/README.rst
diff --git a/docs/dataset_links/bdd100k.rst b/docs/dataset_links/bdd100k.rst
@@ -1,3 +1,3 @@
-Dataset Card - Berkeley Deep Drive Semantic Segmentation (BDD100K)
+Berkeley Deep Drive Semantic Segmentation (BDD100K)
 ==================================================================
 .. include:: ../../src/squirrel_datasets_core/datasets/bdd100k/README.rst
diff --git a/docs/dataset_links/california_housing.rst b/docs/dataset_links/california_housing.rst
@@ -1,3 +1,3 @@
-Dataset Card - California Housing
+California Housing
 ==================================================================
 .. include:: ../../src/squirrel_datasets_core/datasets/california_housing/README.rst
diff --git a/docs/dataset_links/camvid.rst b/docs/dataset_links/camvid.rst
@@ -1,3 +1,3 @@
-Dataset Card - CamVid
+CamVid
 =====================================
 .. include:: ../../src/squirrel_datasets_core/datasets/camvid/README.rst
diff --git a/docs/dataset_links/cc100.rst b/docs/dataset_links/cc100.rst
@@ -1,3 +1,3 @@
-Dataset Card - CC100
+CC100
 =====================================
 .. include:: ../../src/squirrel_datasets_core/datasets/cc100/README.rst
diff --git a/docs/dataset_links/conceptual_captions.rst b/docs/dataset_links/conceptual_captions.rst
@@ -1,3 +1,3 @@
-Dataset Card - Conceptual Captions
+Conceptual Captions
 =====================================
 .. include:: ../../src/squirrel_datasets_core/datasets/conceptual_captions/README.rst
diff --git a/docs/dataset_links/datascience_bowl.rst b/docs/dataset_links/datascience_bowl.rst
@@ -1,3 +1,3 @@
-Dataset Card - Datascience Bowl 2018
+Datascience Bowl 2018
 =====================================
 .. include:: ../../src/squirrel_datasets_core/datasets/ds_bowl_2018/README.rst
diff --git a/docs/dataset_links/fem_simulations.rst b/docs/dataset_links/fem_simulations.rst
@@ -1,3 +1,3 @@
-Dataset Card - GNN BVP Solver
+GNN BVP Solver
 =====================================
-.. include:: ../../../src/squirrel_datasets_core/datasets/fem_simulations/README.rst
+.. include:: ../../src/squirrel_datasets_core/datasets/fem_simulations/README.rst
diff --git a/docs/dataset_links/imagenet.rst b/docs/dataset_links/imagenet.rst
@@ -1,3 +1,3 @@
-Dataset Card - Imagenet
+Imagenet
 =====================================
 .. include:: ../../src/squirrel_datasets_core/datasets/imagenet/README.rst
diff --git a/docs/dataset_links/kaggle_casting_quality.rst b/docs/dataset_links/kaggle_casting_quality.rst
@@ -1,3 +1,3 @@
-Dataset Card - Kaggle Casting Quality
+Kaggle Casting Quality
 =====================================
 .. include:: ../../src/squirrel_datasets_core/datasets/kaggle_casting_quality/README.rst
diff --git a/docs/dataset_links/monthly_german_tweets.rst b/docs/dataset_links/monthly_german_tweets.rst
@@ -1,3 +1,3 @@
-Dataset Card - Monthly German Tweets
+Monthly German Tweets
 =====================================
 .. include:: ../../src/squirrel_datasets_core/datasets/monthly_german_tweets/README.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,30 +9,14 @@ Find out more about Merantix Momentum on our `Website <https://merantix-momentum
 
 .. toctree::
    :maxdepth: 1
-   :caption: Dataset Cards:
+   :caption: Dataset Cards
+   :glob:
 
-   dataset_links/adult
-   dataset_links/allenai_c4
-   dataset_links/automl
-   dataset_links/california_housing
-   dataset_links/camvid
-   dataset_links/cc100
-   dataset_links/conceptual_captions
-   dataset_links/datascience_bowl
-   dataset_links/kaggle_casting_quality
-   dataset_links/imagenet
-   dataset_links/monthly_german_tweets
-   dataset_links/bdd100k
-   dataset_links/adult
-   dataset_links/automl
-   dataset_links/fem_simulations
-
-Contribute
-------------------
+   dataset_links/*
 
 .. toctree::
    :maxdepth: 1
-   :caption: Developer Guide:
+   :caption: Contribute
 
    add_dataset
    code_of_conduct

diff --git a/src/squirrel_datasets_core/datasets/AutoML/README.rst b/src/squirrel_datasets_core/datasets/AutoML/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - Automated Deep Learning
     *   - annotations_creators
@@ -46,11 +48,13 @@ Make sure that squirrel-dataset-core is installed via pip, which will register t
 Use the following code to load the data:
 
 .. code-block:: python
+
     from squirrel.catalog import Catalog
     plugin_catalog = Catalog.from_plugins()
     it = plugin_catalog["helena"].get_driver().get_iter(split="train")
 
 .. code-block:: python
+
     from squirrel.catalog import Catalog
     plugin_catalog = Catalog.from_plugins()
     it = plugin_catalog["jannis"].get_driver().get_iter(split="train")
@@ -64,6 +68,7 @@ Data Instances
 A sample from the Helena training set is provided below:
 
 .. code-block::
+
     {
         'features': [
             0.200384,
@@ -95,7 +100,7 @@ A sample from the Helena training set is provided below:
             0.394317
         ],
         'class': 9
-}
+    }
 
 Dataset Schema
 **************
@@ -105,13 +110,20 @@ All features are continuous floats. There are in total 100 classes to predict. T
 Data Splits
 ***********
 
-+------------+------+
-|   name     |      |
-+------------+------+
-|Helena train|65,196|
-|Helena test |18,628|
-|Helena valid| 9,314|
-|Jannis train|83,733|
-|Jannis test | 9,851|
-|Jannis valid| 4,926|
-+------------+------+
+.. list-table::
+    :header-rows: 1
+
+    *   - name
+        - samples
+    *   - Helena train
+        - 65,196
+    *   - Helena test
+        - 18,628
+    *   - Helena valid
+        - 9,314
+    *   - Jannis train
+        - 83,733
+    *   - Jannis test
+        - 9,851
+    *   - Jannis valid
+        - 4,926
diff --git a/src/squirrel_datasets_core/datasets/adult_dataset/README.rst b/src/squirrel_datasets_core/datasets/adult_dataset/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - Adult income
     *   - annotations_creators
@@ -43,9 +45,11 @@ Make sure that squirrel-dataset-core is installed via pip, which will register t
 Use the following code to load the data:
 
 .. code-block:: python
+
     from squirrel.catalog import Catalog
     plugin_catalog = Catalog.from_plugins()
     it = plugin_catalog["adult_income"].get_driver().get_iter(split="train")
+
 Dataset Structure
 ###################
 
@@ -55,6 +59,7 @@ Data Instances
 A sample from the training set is provided below:
 
 .. code-block::
+
     {
         'age': 1,
         'workclass': 'Private',
@@ -72,6 +77,7 @@ A sample from the training set is provided below:
         'native-country': 'United-States',
         'class': '>50K'
     }
+
 Dataset Schema
 **************
 

diff --git a/src/squirrel_datasets_core/datasets/allenai_c4/README.rst b/src/squirrel_datasets_core/datasets/allenai_c4/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - Allenai C4
     *   - annotations_creators

diff --git a/src/squirrel_datasets_core/datasets/bdd100k/README.rst b/src/squirrel_datasets_core/datasets/bdd100k/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - BDD100K Dataset
     *   - annotations_creators

diff --git a/src/squirrel_datasets_core/datasets/california_housing/README.rst b/src/squirrel_datasets_core/datasets/california_housing/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - California Housing
     *   - annotations_creators

diff --git a/src/squirrel_datasets_core/datasets/camvid/README.rst b/src/squirrel_datasets_core/datasets/camvid/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - CamVid Dataset
     *   - annotations_creators

diff --git a/src/squirrel_datasets_core/datasets/cc100/README.rst b/src/squirrel_datasets_core/datasets/cc100/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - CC 100
     *   - annotations_creators

diff --git a/src/squirrel_datasets_core/datasets/conceptual_captions/README.rst b/src/squirrel_datasets_core/datasets/conceptual_captions/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - Conceptual Captions
     *   - annotations_creators

diff --git a/src/squirrel_datasets_core/datasets/ds_bowl_2018/README.rst b/src/squirrel_datasets_core/datasets/ds_bowl_2018/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - 2018 Datascience Bowl
     *   - annotations_creators

diff --git a/src/squirrel_datasets_core/datasets/fem_simulations/README.rst b/src/squirrel_datasets_core/datasets/fem_simulations/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - FEM Data for BVP GNN solver
     *   - annotations_creators

diff --git a/src/squirrel_datasets_core/datasets/imagenet/README.rst b/src/squirrel_datasets_core/datasets/imagenet/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - Imagenet Dataset
     *   - annotations_creators

diff --git a/src/squirrel_datasets_core/datasets/kaggle_casting_quality/README.rst b/src/squirrel_datasets_core/datasets/kaggle_casting_quality/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - Kaggle Casting Quality
     *   - annotations_creators

diff --git a/src/squirrel_datasets_core/datasets/monthly_german_tweets/README.rst b/src/squirrel_datasets_core/datasets/monthly_german_tweets/README.rst
@@ -1,6 +1,8 @@
 .. list-table::
     :header-rows: 1
-
+
+    *   - Attribute
+        - Value
     *   - pretty_name
         - Monthly German Tweets
     *   - annotations_creators