0.3.1 • Published 6 years ago

algorithmhub v0.3.1

Weekly downloads
-
License
Unlicense
Repository
-
Last release
6 years ago

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

ClassMethodHTTP requestDescription
algorithmhub.BenchmarkApicreateBenchmarkPOST /benchmarkCreate Benchmark
algorithmhub.BenchmarkApigetInfoBenchmarkGET /benchmark/{bid}Get benchmark info
algorithmhub.BenchmarkApilistBenchmarkGET /benchmark/{bid}/modelsGet benchmark list
algorithmhub.BenchmarkTestsApicreateBenchmarkPOST /model/{mid}/benchmarkCreate new benchmark
algorithmhub.BenchmarkTestsApideleteBenchmarkDELETE /model/{mid}/benchmark/{bid}Delete a benchmark
algorithmhub.BenchmarkTestsApilistBenchmarkGET /model/{mid}/benchmarkList benchmark tests
algorithmhub.BenchmarkTestsApirunBenchmarkGET /model/{mid}/benchmark/{bid}Run benchmark
algorithmhub.BenchmarkTestsApiupdateBenchmarkPUT /model/{mid}/benchmark/{bid}Update a benchmark
algorithmhub.BenchmarkTestsApivalidateBenchmarkGET /run/{mid}/benchmark/resultsValidation using default parameters
algorithmhub.ClusterApicreateClusterPOST /clusterCreates new cluster
algorithmhub.ClusterApideleteClusterDELETE /cluster/{cid}Delete an existing cluster
algorithmhub.ClusterApidetailClusterGET /cluster/{cid}Gets cluster metadata
algorithmhub.ClusterApilistClustersGET /clusterReturns list of cluster resources
algorithmhub.ComputeApicreateComputePOST /computeCreates new compute
algorithmhub.ComputeApideleteComputeDELETE /compute/{cnid}Delete an existing compute
algorithmhub.ComputeApidetailComputeGET /compute/{cnid}Gets compute metadata
algorithmhub.ComputeApilistComputeGET /computeReturns list of compute resources
algorithmhub.DataApideleteDataDELETE /data/{did}Deletes the data object
algorithmhub.DataApidownloadDataGET /data/{did}Get the data object
algorithmhub.DataApigetDataGET /data/{did}/infoGet information on the data
algorithmhub.DataApilistDataGET /dataReturn a list of data
algorithmhub.DataApiuploadDataPOST /dataUpload data
algorithmhub.ModelApicreateModelPOST /modelCreate a new model
algorithmhub.ModelApicreateModel_0POST /serviceCreate a new model
algorithmhub.ModelApideleteModelDELETE /model/{mid}Delete details of model
algorithmhub.ModelApideleteModelTrainDELETE /model/{mid}/train/{trid}Delete trained model
algorithmhub.ModelApideleteModel_0DELETE /service/{mid}Delete details of model
algorithmhub.ModelApidetailModelGET /model/{mid}Get details of model
algorithmhub.ModelApidetailModel_0GET /service/{mid}Get details of model
algorithmhub.ModelApieditModelPUT /model/{mid}Edit a model
algorithmhub.ModelApieditModelTrainPUT /model/{mid}/train/{trid}Edit a trained model
algorithmhub.ModelApieditModel_0PUT /service/{mid}Edit a model
algorithmhub.ModelApifitModelTrainPOST /model/{mid}/trainFit the model
algorithmhub.ModelApilistModelTrainGET /model/{mid}/trainList out trained models
algorithmhub.ModelApilistModelsGET /modelReturn models owned
algorithmhub.ModelApilistModels_0GET /serviceReturn models owned
algorithmhub.ModelApirunModelPOST /model/{mid}Run a model
algorithmhub.ModelApirunModelTrainPOST /model/{mid}/train/{trid}Run a training
algorithmhub.ModelApirunModel_0POST /service/{mid}Run a model
algorithmhub.RunApiaddFileRunPOST /run/{rid}/filePRIVATE
algorithmhub.RunApidetailRunGET /run/{rid}Get info about run
algorithmhub.RunApigetInputGET /run/{rid}/inputInput parameters
algorithmhub.RunApigetOutputGET /run/{rid}/outputGet the output
algorithmhub.RunApigetOutputFigureGET /run/{rid}/figure/{fid}/*Get figure as app
algorithmhub.RunApigetOutputFileGET /run/{rid}/file/{filename}Get a file
algorithmhub.RunApigetStatusGET /run/{rid}/statusGet status of the run
algorithmhub.RunApilistOutputFiguresGET /run/{rid}/figuresGet list of figures
algorithmhub.RunApilistOutputFilesGET /run/{rid}/filesGet list of output files
algorithmhub.RunApilistRunsGET /runGet list of runs
algorithmhub.RunApipostErrorPOST /run/{rid}/errorPRIVATE
algorithmhub.RunApipostFigurePOST /run/{rid}/figurePRIVATE
algorithmhub.RunApipostStatusPOST /run/{rid}/statusPRIVATE
algorithmhub.RunApisetSuccessPOST /run/{rid}PRIVATE
algorithmhub.UnitTestsApicreateTestPOST /model/{mid}/testCreate new spec test
algorithmhub.UnitTestsApideleteTestDELETE /model/{mid}/test/{tid}Delete a spec test
algorithmhub.UnitTestsApilistTestGET /model/{mid}/testList spec tests
algorithmhub.UnitTestsApirunKeyboardInterruptGET /run/{rid}/test/keyboardInterruptCheck for keyboard interrupt
algorithmhub.UnitTestsApirunRuntimeErrorGET /run/{rid}/test/runtimeErrorCheck for runtime error
algorithmhub.UnitTestsApirunTestPOST /model/{mid}/test/{tid}Run the tests
algorithmhub.UnitTestsApiupdateTestPUT /model/{mid}/test/{tid}Update a spec test
algorithmhub.UnitTestsApivalidateDataGET /data/{did}/test/validateChecks valid data set
algorithmhub.UnitTestsApivalidateModelGET /model/{mid}/test/validateRuns the unit test cases
algorithmhub.UnitTestsApivalidateRunGET /run/{rid}/test/validateRuns the unit test cases
algorithmhub.WorkspaceApicloneWorkspacePOST /workspace/{wmid}/cloneClone the workspace
algorithmhub.WorkspaceApicreateWorkspacePOST /workspaceCreates new workspace
algorithmhub.WorkspaceApideleteWorkspaceDELETE /workspace/{wmid}Delete an existing workspace
algorithmhub.WorkspaceApidetailWorkspaceGET /workspace/{wmid}Gets workspace metadata
algorithmhub.WorkspaceApilistServicesGET /workspace/{wmid}/modelGet models associated
algorithmhub.WorkspaceApilistServices_0GET /workspace/{wmid}/serviceGet models associated
algorithmhub.WorkspaceApilistWorkspacesGET /workspaceReturns list of workspaces
algorithmhub.WorkspaceApipublishWorkspacePOST /workspace/{wmid}/publishPublish workspace to repo
algorithmhub.WorkspaceApishareWorkspacePOST /workspace/{wmid}/shareShare workspace with another user
algorithmhub.WorkspaceApiturnOffWorkspacePOST /workspace/{wmid}/offTurn off the workspace
algorithmhub.WorkspaceApiturnOnWorkspacePOST /workspace/{wmid}/onTurn on the workspace

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

0.3.1

6 years ago

0.3.0

6 years ago

0.2.8

6 years ago

0.2.7

6 years ago

0.2.6

6 years ago

0.2.5

7 years ago

0.2.4

7 years ago

0.2.3

7 years ago

0.2.1

7 years ago

0.2.0

7 years ago