Sign in
Machine Learning

Add ML Backend

Add an ML backend to a project using the Label Studio UI or by sending a POST request using the following cURL 
command:
```bash
curl -X POST -H 'Content-type: application/json' http://localhost:8000/api/ml -H 'Authorization: Token abc123'\
--data '{"url": "http://localhost:9090", "project": {project_id}}'
post/api/ml/

Request body

auth_method'NONE' | 'BASIC_AUTH'
  • NONE - None
  • BASIC_AUTH - Basic Auth
auto_updateboolean

If false, model version is set by the user, if true - getting latest version from backend.

basic_auth_passstring nullable
basic_auth_userstring nullable

HTTP Basic Auth user

descriptionstring nullable

Description for the machine learning backend

{"stackTrail":"components:schemas:MLBackendRequestRequest:properties:extra_params","oasType":"schema","type":"unknown","description":"Any extra parameters passed to the ML Backend during the setup","nullable":true}
is_interactiveboolean

Used to interactively annotate tasks. If true, model returns one list with results

model_versionstring nullable

Current model version associated with this machine learning backend

projectinteger required
timeoutnumber double

Response model timeout

titlestring nullable

Name of the machine learning backend

urlstring required

URL for the machine learning model server

Response

auth_method'NONE' | 'BASIC_AUTH'
  • NONE - None
  • BASIC_AUTH - Basic Auth
auto_updateboolean

If false, model version is set by the user, if true - getting latest version from backend.

basic_auth_pass_is_setboolean required
basic_auth_userstring nullable

HTTP Basic Auth user

created_atstring date-time required
descriptionstring nullable

Description for the machine learning backend

error_messagestring nullable

Error message in error state

{"stackTrail":"components:schemas:MLBackend:properties:extra_params","oasType":"schema","type":"unknown","description":"Any extra parameters passed to the ML Backend during the setup","nullable":true}
idinteger required
is_interactiveboolean

Used to interactively annotate tasks. If true, model returns one list with results

model_versionstring nullable

Current model version associated with this machine learning backend

projectinteger required
readable_statestring required
state'CO' | 'DI' | 'ER' | 'TR' | 'PR'
  • CO - Connected
  • DI - Disconnected
  • ER - Error
  • TR - Training
  • PR - Predicting
timeoutnumber double

Response model timeout

titlestring nullable

Name of the machine learning backend

updated_atstring date-time required
urlstring required

URL for the machine learning model server

Changes

Changed in 1 of the 97 revisions of this API.511

  • e1ba2ecdbabb511See the full diff
    • ▲

      request body became required

      request-body-became-required

    • ▲

      the request property project became required

      request-property-became-required

    • ▲

      the request property url became required

      request-property-became-required

    • ▲

      the url request property's minLength was increased from 0 to 1

      request-property-min-length-increased

    • ▲

      the extra_params request property type/format changed from object/ to /

      request-property-type-changed

    • ○

      added the new optional request property auto_update

      new-optional-request-property

    • ○

      added the new optional request property model_version

      new-optional-request-property

    • ○

      added the media type application/x-www-form-urlencoded to the request body

      request-body-media-type-added

    • ○

      added the media type multipart/form-data to the request body

      request-body-media-type-added

    • ○

      the request optional property basic_auth_pass became write-only

      request-optional-property-became-write-only

    • ○

      the request property basic_auth_pass became nullable

      request-property-became-nullable

    • ○

      the request property basic_auth_user became nullable

      request-property-became-nullable

    • ○

      the request property description became nullable

      request-property-became-nullable

    • ○

      the request property extra_params became nullable

      request-property-became-nullable

    • ○

      the request property title became nullable

      request-property-became-nullable

    • ○

      the timeout request property type/format was generalized from integer/ to number/double

      request-property-type-generalized

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 97 revisions, 1 has no diff computed.