Training_platform NPM

training_platform

TrainingPlatform - JavaScript client for training_platform The Training platform allows dataset, models and experiments creation and management. This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install training_platform --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Getting Started

Please follow the installation instruction and execute the following JS code:

var TrainingPlatform = require('training_platform');

var defaultClient = TrainingPlatform.ApiClient.instance;

// Configure OAuth2 access token for authorization: admin_auth
var admin_auth = defaultClient.authentications['admin_auth'];
admin_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new TrainingPlatform.CommitApi()

var datasetId = 789; // {Number} the unique identifier of the target dataset, as an integer


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getHistory(datasetId, callback);

Documentation for API Endpoints

All URIs are relative to http://docs-internal.visenze.com/v1

Class	Method	HTTP request	Description
TrainingPlatform.CommitApi	getHistory	GET /datasets/{dataset_id}/history	get the list of commits of a dataset
TrainingPlatform.ConceptApi	createConcept	POST /datasets/{dataset_id}/concepts	create a new empty concept
TrainingPlatform.ConceptApi	deleteConcept	DELETE /datasets/{dataset_id}/concepts	delete a concept
TrainingPlatform.ConceptApi	getConcepts	GET /datasets/{dataset_id}/concepts	get the list of the concepts of a dataset
TrainingPlatform.ConceptApi	mergeConcepts	POST /datasets/{dataset_id}/concepts/merge	merge concepts
TrainingPlatform.ConceptApi	renameConcept	POST /datasets/{dataset_id}/concepts/rename	rename a concept
TrainingPlatform.Concept_groupApi	createConceptGroup	POST /datasets/{dataset_id}/concepts/group	create a concept group
TrainingPlatform.Concept_groupApi	deleteConceptGroup	DELETE /datasets/{dataset_id}/concepts/group	delete a concept group
TrainingPlatform.Concept_groupApi	getConceptGroups	GET /datasets/{dataset_id}/concepts/group	list concept groups
TrainingPlatform.Data_importation_taskApi	createDataImportationTasks	POST /datasets/{dataset_id}/import/task	Create a data importation task
TrainingPlatform.Data_importation_taskApi	deleteDataImportationTasks	DELETE /datasets/{dataset_id}/import/tasks/{task_id}	Cancel and delete a data importation task
TrainingPlatform.Data_importation_taskApi	getDataImportationTasks	GET /datasets/{dataset_id}/import/task	List all the queued and ongoing data importation tasks on this dataset
TrainingPlatform.DatasetApi	copyDataset	POST /datasets/{dataset_id}/copy	Copies a dataset
TrainingPlatform.DatasetApi	createDataset	POST /datasets	Create a new empty dataset
TrainingPlatform.DatasetApi	deleteDataset	DELETE /datasets/{dataset_id}	Deletes a dataset
TrainingPlatform.DatasetApi	downloadDataset	GET /datasets/{dataset_id}/download	Downloads a dataset
TrainingPlatform.DatasetApi	getDataset	GET /datasets/{dataset_id}	Details of one dataset
TrainingPlatform.DatasetApi	getDatasets	GET /datasets	See the filtered, paged list of all datasets.
TrainingPlatform.DatasetApi	updateDataset	POST /datasets/{dataset_id}	Updates a dataset
TrainingPlatform.ExperimentApi	createExperiment	POST /experiments	create and run an experiment
TrainingPlatform.ExperimentApi	deleteExperiment	DELETE /experiments/{experiment_id}	delete an experiment
TrainingPlatform.ExperimentApi	getExperiment	GET /experiments/{experiment_id}	get html report of an experiment
TrainingPlatform.ExperimentApi	getExperiments	GET /experiments	list experiments
TrainingPlatform.ExperimentApi	stopExperiment	POST /experiments/{experiment_id}/stop	stop a running experiment
TrainingPlatform.ImageApi	deleteImage	DELETE /datasets/{dataset_id}/images	delete an image from a dataset
TrainingPlatform.ImageApi	getImages	GET /datasets/{dataset_id}/images	list images
TrainingPlatform.ImageApi	updateImage	POST /datasets/{dataset_id}/images	update an image
TrainingPlatform.ModelApi	createModel	POST /models	create and train a model
TrainingPlatform.ModelApi	deleteModel	DELETE /models/{model_id}	delete a model
TrainingPlatform.ModelApi	downloadModel	GET /models/{model_id}/download	Downloads a model
TrainingPlatform.ModelApi	getModel	GET /models/{model_id}	get details about one model
TrainingPlatform.ModelApi	getModels	GET /models	list models
TrainingPlatform.ModelApi	stopModel	POST /models/{model_id}/stop	stop training a model
TrainingPlatform.ModelApi	tryModel	POST /models/{model_id}/try	try a model
TrainingPlatform.UserApi	createUser	POST /users	Create user
TrainingPlatform.UserApi	deleteUser	DELETE /user/{username}	Delete user
TrainingPlatform.UserApi	getUserByName	GET /user/{username}	Get user by user name
TrainingPlatform.UserApi	getUsers	GET /users	Get the list of all registered users
TrainingPlatform.UserApi	loginUser	GET /users/login	Logs user into the system
TrainingPlatform.UserApi	logoutUser	GET /users/logout	Logs out current logged in user session
TrainingPlatform.UserApi	updateUser	PUT /user/{username}	Updated user

Documentation for Models

Documentation for Authorization

admin_auth

Type: OAuth
Flow: implicit
Authorization URL: http://training-platform.visenze.com/login
Scopes:
- write:all: modify all
- read:all: read all

api_key

Type: API key
API key parameter name: api_key
Location: HTTP header

superagent

@everything-registry/sub-chunk-2966 @infinitebrahmanuniverse/nolb-trai

1.0.0

8 years ago