Use the utils from MetaDrive to update object summaries; update ScenarioDescription doc (#52)

* Update

* update

* update

* update
This commit is contained in:
Zhenghao (Mark) Peng
2024-01-21 19:52:57 -08:00
committed by GitHub
parent 1f61a4b9d1
commit 07cb55c1cc
4 changed files with 21 additions and 18 deletions

View File

@@ -232,8 +232,8 @@
{
"data": {
"text/plain": [
"\u001b[0;31mSignature:\u001b[0m \u001b[0mread_dataset_summary\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0mdataset_path\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n",
"\u001b[0;31mDocstring:\u001b[0m\n",
"\u001B[0;31mSignature:\u001B[0m \u001B[0mread_dataset_summary\u001B[0m\u001B[0;34m(\u001B[0m\u001B[0mdataset_path\u001B[0m\u001B[0;34m)\u001B[0m\u001B[0;34m\u001B[0m\u001B[0;34m\u001B[0m\u001B[0m\n",
"\u001B[0;31mDocstring:\u001B[0m\n",
"Read the dataset and return the metadata of each scenario in this dataset.\n",
"\n",
"Args:\n",
@@ -244,8 +244,8 @@
" 1) the summary dict mapping from scenario ID to its metadata,\n",
" 2) the list of all scenarios IDs, and\n",
" 3) a dict mapping from scenario IDs to the folder that hosts their files.\n",
"\u001b[0;31mFile:\u001b[0m ~/scenarionet/scenarionet/common_utils.py\n",
"\u001b[0;31mType:\u001b[0m function"
"\u001B[0;31mFile:\u001B[0m ~/scenarionet/scenarionet/common_utils.py\n",
"\u001B[0;31mType:\u001B[0m function"
]
},
"metadata": {},
@@ -3593,8 +3593,8 @@
{
"data": {
"text/plain": [
"\u001b[0;31mSignature:\u001b[0m \u001b[0mread_scenario\u001b[0m\u001b[0;34m(\u001b[0m\u001b[0mdataset_path\u001b[0m\u001b[0;34m,\u001b[0m \u001b[0mmapping\u001b[0m\u001b[0;34m,\u001b[0m \u001b[0mscenario_file_name\u001b[0m\u001b[0;34m)\u001b[0m\u001b[0;34m\u001b[0m\u001b[0;34m\u001b[0m\u001b[0m\n",
"\u001b[0;31mDocstring:\u001b[0m\n",
"\u001B[0;31mSignature:\u001B[0m \u001B[0mread_scenario\u001B[0m\u001B[0;34m(\u001B[0m\u001B[0mdataset_path\u001B[0m\u001B[0;34m,\u001B[0m \u001B[0mmapping\u001B[0m\u001B[0;34m,\u001B[0m \u001B[0mscenario_file_name\u001B[0m\u001B[0;34m)\u001B[0m\u001B[0;34m\u001B[0m\u001B[0;34m\u001B[0m\u001B[0m\n",
"\u001B[0;31mDocstring:\u001B[0m\n",
"Read a scenario pkl file and return the Scenario Description instance.\n",
"\n",
"Args:\n",
@@ -3604,8 +3604,8 @@
"\n",
"Returns:\n",
" The Scenario Description instance of that scenario.\n",
"\u001b[0;31mFile:\u001b[0m ~/scenarionet/scenarionet/common_utils.py\n",
"\u001b[0;31mType:\u001b[0m function"
"\u001B[0;31mFile:\u001B[0m ~/scenarionet/scenarionet/common_utils.py\n",
"\u001B[0;31mType:\u001B[0m function"
]
},
"metadata": {},