Add HyperDataset SDK refrence

This commit is contained in:
allegroai 2021-09-18 00:55:20 +03:00 committed by allegroai
parent f94cda0c98
commit ea5db11939
5 changed files with 26 additions and 18 deletions

View File

@ -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).

View File

@ -1,5 +0,0 @@
---
title: REST API
---
**AutoGenerated PlaceHolder**

View File

@ -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',

View File

@ -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',
]
};