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.

Sign up for GitHub

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

Add note to dataset tutorial about needing to work for multiple shapes for inclusion #220

Merged
merged 1 commit into from
Sep 23, 2024
Merged

Add note to dataset tutorial about needing to work for multiple shapes for inclusion #220

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/custom_datasets.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,3 +124,12 @@ If and only if you are given the go ahead:
1. Add your CSV file to the ``src/data_morph/data/starter_shapes/`` directory.
2. Add an entry to the ``DataLoader._DATASETS`` dictionary in ``src/data_morph/data/loader.py``.
3. Submit your pull request.

.. note::
For inclusion in Data Morph, the proposed dataset must work with more
than one shape. You can pass ``all`` as the target shape to generate all
options for inspection:

.. code:: console

$ data-morph --start-shape path/to/points.csv --target-shape all
2 changes: 1 addition & 1 deletion docs/shape_creation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Test out the shape
Defining how your shape should be generated from the input dataset will require
a few iterations. Be sure to test out your shape on different datasets:

.. code:: shell
.. code:: console

$ data-morph --start-shape panda music soccer --target-shape <your shape>

Expand Down
Loading