From e9a913ad9bd6f7117076fafd1a9e139abb790553 Mon Sep 17 00:00:00 2001 From: Stefanie Molin <24376333+stefmolin@users.noreply.github.com> Date: Mon, 23 Sep 2024 14:43:18 +0800 Subject: [PATCH] Add note to dataset tutorial about needing to work for multiple shapes for inclusion --- docs/custom_datasets.rst | 9 +++++++++ docs/shape_creation.rst | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/docs/custom_datasets.rst b/docs/custom_datasets.rst index b3945484..e44b8bf8 100644 --- a/docs/custom_datasets.rst +++ b/docs/custom_datasets.rst @@ -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 diff --git a/docs/shape_creation.rst b/docs/shape_creation.rst index 8900158a..234a95dc 100644 --- a/docs/shape_creation.rst +++ b/docs/shape_creation.rst @@ -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