From cf604444b37b4683d6cea0c5d383731cb8228bd5 Mon Sep 17 00:00:00 2001 From: Katie Graham Date: Sun, 26 Feb 2023 20:39:13 -0800 Subject: [PATCH] Added note about --data-path in .rst docs --- docs/data_ingestion.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/data_ingestion.rst b/docs/data_ingestion.rst index 1f29fbee33c..71b96438ae0 100644 --- a/docs/data_ingestion.rst +++ b/docs/data_ingestion.rst @@ -1,3 +1,8 @@ +.. role:: bash(code) + :language: bash +.. role:: python(code) + :language: python + Data Ingestion ============== @@ -27,6 +32,14 @@ Legacy Data Readers Some of the legacy data readers are the ``MNIST``, ``ImageNet``, and ``CIFAR10`` data readers. +.. note:: The imagenet data reader uses a path that may not be known + to all compute centers. If the dataset is not found + :python:`--data-path` may be set to the top level of the data + set in :code:`resnet.py`, :code:`alexnet.py`, and + :code:`densenet.py`. The data set is must contain + :code:`labels/train.txt`, :code:`labels/val.txt`, + :code:`train/`, and :code:`val/`. + "New" Data Readers -------------------