Warning

We’re planning to deprecate abeja.models package in the future version. Instead, the abeja.training package contains far more detailed new high-level APIs. Furthermore, these classes provide more consistent and cleaner interface for developers.

ABEJA Model SDK documentation

ABEJA model library is SDK for python, which allows developers to create, get and delete models.

Low level API

Low level API directly accesses the API endpoints.

• API Client
  • APIClient
    • APIClient.archive_training_job()
    • APIClient.archive_training_job_definition()
    • APIClient.archive_training_job_definition_version()
    • APIClient.archive_training_model()
    • APIClient.create_training_job()
    • APIClient.create_training_job_definition()
    • APIClient.create_training_job_definition_version()
    • APIClient.create_training_job_definition_version_native_api()
    • APIClient.create_training_model()
    • APIClient.delete_training_job_definition()
    • APIClient.delete_training_job_definition_version()
    • APIClient.download_training_model()
    • APIClient.get_training_job()
    • APIClient.get_training_job_definition()
    • APIClient.get_training_job_definition_version()
    • APIClient.get_training_job_definition_versions()
    • APIClient.get_training_job_definitions()
    • APIClient.get_training_jobs()
    • APIClient.get_training_model()
    • APIClient.get_training_models()
    • APIClient.get_training_result()
    • APIClient.patch_training_job_definition_version()
    • APIClient.patch_training_model()
    • APIClient.stop_training_job()
    • APIClient.unarchive_training_job()
    • APIClient.unarchive_training_job_definition()
    • APIClient.unarchive_training_job_definition_version()
    • APIClient.unarchive_training_model()
    • APIClient.update_statistics()

Usage

from abeja.models import APIClient

api_client = APIClient()
model = api_client.get_model(organization_id, model_id)
model_versions = api_client.list_model_versions(organization_id, model_id)

API Mapping

method	path	description
get	/organizations/<organization_id>/training/definitions/<job_definition_name>/models	APIClient.get_training_models()
post	/organizations/<organization_id>/training/definitions/<job_definition_name>/models	APIClient.create_training_model()
get	/organizations/<organization_id>/training/definitions/<job_definition_name>/models/<model_id>	APIClient.get_training_model()
patch	/organizations/<organization_id>/training/definitions/<job_definition_name>/models/<model_id>	APIClient.patch_training_model()
get	/organizations/<organization_id>/training/definitions/<job_definition_name>/models/<model_id>/download	APIClient.download_training_model()
post	/organizations/<organization_id>/training/definitions/<job_definition_name>/models/<model_id>/archive	APIClient.archive_training_model()
post	/organizations/<organization_id>/training/definitions/<job_definition_name>/models/<model_id>/unarchive	APIClient.unarchive_training_model()