Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean Up of Existing Documentation #66

Merged
merged 15 commits into from
Nov 4, 2022
2 changes: 1 addition & 1 deletion docs/dataset_links/adult.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - Adult Dataset
Adult
=====================================
.. include:: ../../src/squirrel_datasets_core/datasets/adult_dataset/README.rst
2 changes: 1 addition & 1 deletion docs/dataset_links/allenai_c4.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - AllenAI C4
AllenAI C4
=====================================
.. include:: ../../src/squirrel_datasets_core/datasets/allenai_c4/README.rst
2 changes: 1 addition & 1 deletion docs/dataset_links/automl.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - AutoML
AutoML
=====================================
.. include:: ../../src/squirrel_datasets_core/datasets/AutoML/README.rst
2 changes: 1 addition & 1 deletion docs/dataset_links/bdd100k.rst
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/dataset_links/california_housing.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - California Housing
California Housing
==================================================================
.. include:: ../../src/squirrel_datasets_core/datasets/california_housing/README.rst
2 changes: 1 addition & 1 deletion docs/dataset_links/camvid.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - CamVid
CamVid
=====================================
.. include:: ../../src/squirrel_datasets_core/datasets/camvid/README.rst
2 changes: 1 addition & 1 deletion docs/dataset_links/cc100.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - CC100
CC100
=====================================
.. include:: ../../src/squirrel_datasets_core/datasets/cc100/README.rst
2 changes: 1 addition & 1 deletion docs/dataset_links/conceptual_captions.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - Conceptual Captions
Conceptual Captions
=====================================
.. include:: ../../src/squirrel_datasets_core/datasets/conceptual_captions/README.rst
2 changes: 1 addition & 1 deletion docs/dataset_links/datascience_bowl.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - Datascience Bowl 2018
Datascience Bowl 2018
=====================================
.. include:: ../../src/squirrel_datasets_core/datasets/ds_bowl_2018/README.rst
4 changes: 2 additions & 2 deletions docs/dataset_links/fem_simulations.rst
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion docs/dataset_links/imagenet.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - Imagenet
Imagenet
=====================================
.. include:: ../../src/squirrel_datasets_core/datasets/imagenet/README.rst
2 changes: 1 addition & 1 deletion docs/dataset_links/kaggle_casting_quality.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - Kaggle Casting Quality
Kaggle Casting Quality
=====================================
.. include:: ../../src/squirrel_datasets_core/datasets/kaggle_casting_quality/README.rst
2 changes: 1 addition & 1 deletion docs/dataset_links/monthly_german_tweets.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Dataset Card - Monthly German Tweets
Monthly German Tweets
=====================================
.. include:: ../../src/squirrel_datasets_core/datasets/monthly_german_tweets/README.rst
24 changes: 4 additions & 20 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/*
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice one!


.. toctree::
:maxdepth: 1
:caption: Developer Guide:
:caption: Contribute

add_dataset
code_of_conduct
Expand Down
36 changes: 24 additions & 12 deletions src/squirrel_datasets_core/datasets/AutoML/README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- Automated Deep Learning
* - annotations_creators
Expand Down Expand Up @@ -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")
Expand All @@ -64,6 +68,7 @@ Data Instances
A sample from the Helena training set is provided below:

.. code-block::

{
'features': [
0.200384,
Expand Down Expand Up @@ -95,7 +100,7 @@ A sample from the Helena training set is provided below:
0.394317
],
'class': 9
}
}

Dataset Schema
**************
Expand All @@ -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
8 changes: 7 additions & 1 deletion src/squirrel_datasets_core/datasets/adult_dataset/README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- Adult income
* - annotations_creators
Expand Down Expand Up @@ -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
###################

Expand All @@ -55,6 +59,7 @@ Data Instances
A sample from the training set is provided below:

.. code-block::

{
'age': 1,
'workclass': 'Private',
Expand All @@ -72,6 +77,7 @@ A sample from the training set is provided below:
'native-country': 'United-States',
'class': '>50K'
}

Dataset Schema
**************

Expand Down
4 changes: 3 additions & 1 deletion src/squirrel_datasets_core/datasets/allenai_c4/README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- Allenai C4
* - annotations_creators
Expand Down
4 changes: 3 additions & 1 deletion src/squirrel_datasets_core/datasets/bdd100k/README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- BDD100K Dataset
* - annotations_creators
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- California Housing
* - annotations_creators
Expand Down
4 changes: 3 additions & 1 deletion src/squirrel_datasets_core/datasets/camvid/README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- CamVid Dataset
* - annotations_creators
Expand Down
4 changes: 3 additions & 1 deletion src/squirrel_datasets_core/datasets/cc100/README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- CC 100
* - annotations_creators
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- Conceptual Captions
* - annotations_creators
Expand Down
4 changes: 3 additions & 1 deletion src/squirrel_datasets_core/datasets/ds_bowl_2018/README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- 2018 Datascience Bowl
* - annotations_creators
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- FEM Data for BVP GNN solver
* - annotations_creators
Expand Down
4 changes: 3 additions & 1 deletion src/squirrel_datasets_core/datasets/imagenet/README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- Imagenet Dataset
* - annotations_creators
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- Kaggle Casting Quality
* - annotations_creators
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
.. list-table::
:header-rows: 1


* - Attribute
- Value
* - pretty_name
- Monthly German Tweets
* - annotations_creators
Expand Down