algorithmhub

algorithmhub - JavaScript client for algorithmhub No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

API version: 0.0.1
Package version: 0.3.1
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 algorithmhub --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your algorithmhub from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('algorithmhub') in javascript files from the directory you ran the last command above from.

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, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var algorithmhub = require('algorithmhub');

var api = new algorithmhub.BenchmarkApi()
api.createBenchmark().then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost:10010/v2

Class	Method	HTTP request	Description
algorithmhub.BenchmarkApi	createBenchmark	POST /benchmark	Create Benchmark
algorithmhub.BenchmarkApi	getInfoBenchmark	GET /benchmark/{bid}	Get benchmark info
algorithmhub.BenchmarkApi	listBenchmark	GET /benchmark/{bid}/models	Get benchmark list
algorithmhub.BenchmarkTestsApi	createBenchmark	POST /model/{mid}/benchmark	Create new benchmark
algorithmhub.BenchmarkTestsApi	deleteBenchmark	DELETE /model/{mid}/benchmark/{bid}	Delete a benchmark
algorithmhub.BenchmarkTestsApi	listBenchmark	GET /model/{mid}/benchmark	List benchmark tests
algorithmhub.BenchmarkTestsApi	runBenchmark	GET /model/{mid}/benchmark/{bid}	Run benchmark
algorithmhub.BenchmarkTestsApi	updateBenchmark	PUT /model/{mid}/benchmark/{bid}	Update a benchmark
algorithmhub.BenchmarkTestsApi	validateBenchmark	GET /run/{mid}/benchmark/results	Validation using default parameters
algorithmhub.ClusterApi	createCluster	POST /cluster	Creates new cluster
algorithmhub.ClusterApi	deleteCluster	DELETE /cluster/{cid}	Delete an existing cluster
algorithmhub.ClusterApi	detailCluster	GET /cluster/{cid}	Gets cluster metadata
algorithmhub.ClusterApi	listClusters	GET /cluster	Returns list of cluster resources
algorithmhub.ComputeApi	createCompute	POST /compute	Creates new compute
algorithmhub.ComputeApi	deleteCompute	DELETE /compute/{cnid}	Delete an existing compute
algorithmhub.ComputeApi	detailCompute	GET /compute/{cnid}	Gets compute metadata
algorithmhub.ComputeApi	listCompute	GET /compute	Returns list of compute resources
algorithmhub.DataApi	deleteData	DELETE /data/{did}	Deletes the data object
algorithmhub.DataApi	downloadData	GET /data/{did}	Get the data object
algorithmhub.DataApi	getData	GET /data/{did}/info	Get information on the data
algorithmhub.DataApi	listData	GET /data	Return a list of data
algorithmhub.DataApi	uploadData	POST /data	Upload data
algorithmhub.ModelApi	createModel	POST /model	Create a new model
algorithmhub.ModelApi	createModel_0	POST /service	Create a new model
algorithmhub.ModelApi	deleteModel	DELETE /model/{mid}	Delete details of model
algorithmhub.ModelApi	deleteModelTrain	DELETE /model/{mid}/train/{trid}	Delete trained model
algorithmhub.ModelApi	deleteModel_0	DELETE /service/{mid}	Delete details of model
algorithmhub.ModelApi	detailModel	GET /model/{mid}	Get details of model
algorithmhub.ModelApi	detailModel_0	GET /service/{mid}	Get details of model
algorithmhub.ModelApi	editModel	PUT /model/{mid}	Edit a model
algorithmhub.ModelApi	editModelTrain	PUT /model/{mid}/train/{trid}	Edit a trained model
algorithmhub.ModelApi	editModel_0	PUT /service/{mid}	Edit a model
algorithmhub.ModelApi	fitModelTrain	POST /model/{mid}/train	Fit the model
algorithmhub.ModelApi	listModelTrain	GET /model/{mid}/train	List out trained models
algorithmhub.ModelApi	listModels	GET /model	Return models owned
algorithmhub.ModelApi	listModels_0	GET /service	Return models owned
algorithmhub.ModelApi	runModel	POST /model/{mid}	Run a model
algorithmhub.ModelApi	runModelTrain	POST /model/{mid}/train/{trid}	Run a training
algorithmhub.ModelApi	runModel_0	POST /service/{mid}	Run a model
algorithmhub.RunApi	addFileRun	POST /run/{rid}/file	PRIVATE
algorithmhub.RunApi	detailRun	GET /run/{rid}	Get info about run
algorithmhub.RunApi	getInput	GET /run/{rid}/input	Input parameters
algorithmhub.RunApi	getOutput	GET /run/{rid}/output	Get the output
algorithmhub.RunApi	getOutputFigure	GET /run/{rid}/figure/{fid}/*	Get figure as app
algorithmhub.RunApi	getOutputFile	GET /run/{rid}/file/{filename}	Get a file
algorithmhub.RunApi	getStatus	GET /run/{rid}/status	Get status of the run
algorithmhub.RunApi	listOutputFigures	GET /run/{rid}/figures	Get list of figures
algorithmhub.RunApi	listOutputFiles	GET /run/{rid}/files	Get list of output files
algorithmhub.RunApi	listRuns	GET /run	Get list of runs
algorithmhub.RunApi	postError	POST /run/{rid}/error	PRIVATE
algorithmhub.RunApi	postFigure	POST /run/{rid}/figure	PRIVATE
algorithmhub.RunApi	postStatus	POST /run/{rid}/status	PRIVATE
algorithmhub.RunApi	setSuccess	POST /run/{rid}	PRIVATE
algorithmhub.UnitTestsApi	createTest	POST /model/{mid}/test	Create new spec test
algorithmhub.UnitTestsApi	deleteTest	DELETE /model/{mid}/test/{tid}	Delete a spec test
algorithmhub.UnitTestsApi	listTest	GET /model/{mid}/test	List spec tests
algorithmhub.UnitTestsApi	runKeyboardInterrupt	GET /run/{rid}/test/keyboardInterrupt	Check for keyboard interrupt
algorithmhub.UnitTestsApi	runRuntimeError	GET /run/{rid}/test/runtimeError	Check for runtime error
algorithmhub.UnitTestsApi	runTest	POST /model/{mid}/test/{tid}	Run the tests
algorithmhub.UnitTestsApi	updateTest	PUT /model/{mid}/test/{tid}	Update a spec test
algorithmhub.UnitTestsApi	validateData	GET /data/{did}/test/validate	Checks valid data set
algorithmhub.UnitTestsApi	validateModel	GET /model/{mid}/test/validate	Runs the unit test cases
algorithmhub.UnitTestsApi	validateRun	GET /run/{rid}/test/validate	Runs the unit test cases
algorithmhub.WorkspaceApi	cloneWorkspace	POST /workspace/{wmid}/clone	Clone the workspace
algorithmhub.WorkspaceApi	createWorkspace	POST /workspace	Creates new workspace
algorithmhub.WorkspaceApi	deleteWorkspace	DELETE /workspace/{wmid}	Delete an existing workspace
algorithmhub.WorkspaceApi	detailWorkspace	GET /workspace/{wmid}	Gets workspace metadata
algorithmhub.WorkspaceApi	listServices	GET /workspace/{wmid}/model	Get models associated
algorithmhub.WorkspaceApi	listServices_0	GET /workspace/{wmid}/service	Get models associated
algorithmhub.WorkspaceApi	listWorkspaces	GET /workspace	Returns list of workspaces
algorithmhub.WorkspaceApi	publishWorkspace	POST /workspace/{wmid}/publish	Publish workspace to repo
algorithmhub.WorkspaceApi	shareWorkspace	POST /workspace/{wmid}/share	Share workspace with another user
algorithmhub.WorkspaceApi	turnOffWorkspace	POST /workspace/{wmid}/off	Turn off the workspace
algorithmhub.WorkspaceApi	turnOnWorkspace	POST /workspace/{wmid}/on	Turn on the workspace

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

Name		Name	Last commit message	Last commit date
Latest commit History 8 Commits
.swagger-codegen		.swagger-codegen
docs		docs
src		src
test		test
.swagger-codegen-ignore		.swagger-codegen-ignore
.travis.yml		.travis.yml
README.md		README.md
git_push.sh		git_push.sh
mocha.opts		mocha.opts
package.json		package.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

algorithmhub

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

About

Releases

Packages

Languages

AlgorithmHub/algorithmhub-node

Folders and files

Latest commit

History

Repository files navigation

algorithmhub

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages