diff --git a/documentation/datasets.rst b/documentation/datasets.rst index 8af0278..fd4fe24 100644 --- a/documentation/datasets.rst +++ b/documentation/datasets.rst @@ -5,11 +5,22 @@ Datasets Generally, the detailed setup procedure for each dataset can be found at its official document. In this section, we still provide a simple guidance about how to setup each dataset in a step by step way, saving the time for redirecting to new sites and read the comprehensive guidance. + The content of each subsection is a simplified version based on the official setup procedures of each dataset. Thus if you encountered some problems with our simplified setup instructions, please read related official documentation. -Also, we kindly ask you to report the encountered problem when following our procedures. -We will fix it as best as we can and record it in the troubleshooting section for each dataset. + +**Also, we kindly ask you to report the encountered problem when following our procedures. +We will fix it as best as we can and record it in the troubleshooting section for each dataset.** |:blush:| + +.. modify the toctree in index` together + +- :ref:`nuplan` +- :ref:`nuscenes` +- :ref:`waymo` +- :ref:`PG` +- :ref:`lyft` +- :ref:`new_data` diff --git a/documentation/index.rst b/documentation/index.rst index 1f38f1f..c7f8d7f 100644 --- a/documentation/index.rst +++ b/documentation/index.rst @@ -19,16 +19,20 @@ Please feel free to contact us if you have any suggestions or ideas! .. toctree:: :maxdepth: 2 - :hidden: :caption: Quick Start install.rst example.rst - operations.rst .. toctree:: - :hidden: :maxdepth: 2 + :caption: Database Operations + + operations.rst + +.. modify the toctree in datasets.rst together +.. toctree:: + :maxdepth: 1 :caption: Supported Dataset datasets.rst @@ -40,7 +44,6 @@ Please feel free to contact us if you have any suggestions or ideas! new_data.rst .. toctree:: - :hidden: :maxdepth: 2 :caption: System Design diff --git a/documentation/lyft.rst b/documentation/lyft.rst index dadb69e..3cd59a2 100644 --- a/documentation/lyft.rst +++ b/documentation/lyft.rst @@ -1,3 +1,5 @@ +.. _lyft: + #################### Lyft (In Upgrading) #################### diff --git a/documentation/operations.rst b/documentation/operations.rst index f1da48d..2bf26f6 100644 --- a/documentation/operations.rst +++ b/documentation/operations.rst @@ -1,6 +1,7 @@ -############### -Operations -############### +.. _operations: + +How to run +~~~~~~~~~~ We provide various basic operations allowing users to modify the built database for ML applications. These operations include building database from different data providers;aggregating datasets from diverse source;