diff --git a/docs/fundamentals/projects.md b/docs/fundamentals/projects.md index 054499b5..8f28b351 100644 --- a/docs/fundamentals/projects.md +++ b/docs/fundamentals/projects.md @@ -42,7 +42,7 @@ Task.init(project_name='main_project/sub_project', task_name='test') Nesting projects works on multiple levels. For example: `project_name=main_project/sub_project/sub_sub_project` -Projects can also be created using the [`projects.create`](../references/api/endpoints.md#post-projectscreate) REST API call. +Projects can also be created using the [`projects.create`](../references/api/projects.md#post-projectscreate) REST API call. ### View All Projects in System @@ -57,11 +57,11 @@ This returns a list of project sorted by last update time. ### More Actions For additional ways to work with projects, use the REST API `projects` resource. Some of the available actions include: -* [`projects.create`](../references/api/endpoints.md#post-projectscreate) and [`projects.delete`](../references/api/endpoints.md#post-projectsdelete) - create and delete projects -* [`projects.get_hyper_parameters`](../references/api/endpoints.md#post-projectsget_hyper_parameters) - get a list of all hyperparameter sections and names used in a project -* [`projects.merge_projects`](../references/api/endpoints.md#post-projectsmerge) - merge projects into a single project +* [`projects.create`](../references/api/projects.md#post-projectscreate) and [`projects.delete`](../references/api/projects.md#post-projectsdelete) - create and delete projects +* [`projects.get_hyper_parameters`](../references/api/projects.md#post-projectsget_hyper_parameters) - get a list of all hyperparameter sections and names used in a project +* [`projects.merge_projects`](../references/api/projects.md#post-projectsmerge) - merge projects into a single project -See more in the [REST API reference](../references/api/endpoints.md#projects). +See more in the [REST API reference](../references/api/projects.md#projects). diff --git a/docs/references/api/endpoints.md b/docs/references/api/endpoints.md deleted file mode 100644 index 10d5386d..00000000 --- a/docs/references/api/endpoints.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: REST API ---- - -**AutoGenerated PlaceHolder** \ No newline at end of file diff --git a/docs/references/hyperdataset/.autogenerated b/docs/references/hyperdataset/.autogenerated new file mode 100644 index 00000000..e69de29b diff --git a/docusaurus.config.js b/docusaurus.config.js index 4ced58fb..6e49bc02 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -80,9 +80,13 @@ module.exports = { label: 'SDK', to: '/docs/references/sdk/task', }, + { + label: 'HyperDatasets', + to: '/docs/references/hyperdataset/hyperdataset', + }, { label: 'Server API', - to: '/docs/references/api/endpoints', + to: '/docs/references/api/index', }, { label: 'Agent Reference', diff --git a/sidebars.js b/sidebars.js index 947b68c9..c0e96eb3 100644 --- a/sidebars.js +++ b/sidebars.js @@ -135,7 +135,6 @@ module.exports = { 'references/sdk/hpo_parameters_parameterset', ]}, ], - hyperdatasetsSidebar: [ 'hyperdatasets/overview', {'Frames': [ @@ -166,11 +165,21 @@ module.exports = { 'hyperdatasets/webapp/webapp_annotator' ]} ], - - - apiSidebar: [ - 'references/api/definitions', - 'references/api/endpoints', + sdkHyperDataset: [ + {'HyperDataset': ['references/hyperdataset/hyperdataset', 'references/hyperdataset/hyperdatasetversion']}, + {'DataFrame': ['references/hyperdataset/singleframe', + 'references/hyperdataset/framegroup', 'references/hyperdataset/annotation',]}, + 'references/hyperdataset/dataview', ], - + apiSidebar: [ + 'references/api/index', + 'references/api/definitions', + 'references/api/login', + 'references/api/debug', + 'references/api/projects', + 'references/api/queues', + 'references/api/workers', + 'references/api/events', + 'references/api/tasks', + ] };