ABEJA Training documentation (abeja.training)

ABEJA training library is SDK for python, which allows developers to create, get and delete training related resources.

High level API

High-level API is used through following classes.

• Client
  • Client
    • Client.job_definitions()
  • Entity classes
    • JobDefinition
      • JobDefinition
        • JobDefinition.archived
        • JobDefinition.created_at
        • JobDefinition.from_response()
        • JobDefinition.job_definition_id
        • JobDefinition.job_definition_versions()
        • JobDefinition.jobs()
        • JobDefinition.model_count
        • JobDefinition.models()
        • JobDefinition.modified_at
        • JobDefinition.name
        • JobDefinition.notebook_count
        • JobDefinition.organization_id
        • JobDefinition.tensorboard_count
        • JobDefinition.version_count
        • JobDefinition.versions
    • JobDefinitionVersion
      • JobDefinitionVersion
        • JobDefinitionVersion.archived
        • JobDefinitionVersion.created_at
        • JobDefinitionVersion.description
        • JobDefinitionVersion.environment
        • JobDefinitionVersion.from_response()
        • JobDefinitionVersion.handler
        • JobDefinitionVersion.image
        • JobDefinitionVersion.job_definition
        • JobDefinitionVersion.job_definition_id
        • JobDefinitionVersion.job_definition_version_id
        • JobDefinitionVersion.modified_at
        • JobDefinitionVersion.organization_id
    • Job
      • Job
        • Job.archived
        • Job.completion_time
        • Job.created_at
        • Job.creator
        • Job.datasets
        • Job.description
        • Job.environment
        • Job.exec_env
        • Job.from_response()
        • Job.instance_type
        • Job.job_definition
        • Job.job_definition_id
        • Job.job_definition_version
        • Job.job_definition_version_id
        • Job.job_id
        • Job.modified_at
        • Job.organization_id
        • Job.start_time
        • Job.statistics
        • Job.status
        • Job.status_message
    • Model
      • Model
        • Model.archived
        • Model.created_at
        • Model.creator
        • Model.description
        • Model.environment
        • Model.exec_env
        • Model.from_response()
        • Model.job
        • Model.job_definition
        • Model.job_definition_id
        • Model.job_id
        • Model.metrics
        • Model.model_id
        • Model.modified_at
        • Model.organization_id
  • Adapter classes
    • JobDefinitions
      • JobDefinitions
        • JobDefinitions.archive()
        • JobDefinitions.create()
        • JobDefinitions.delete()
        • JobDefinitions.get()
        • JobDefinitions.list()
        • JobDefinitions.organization_id
        • JobDefinitions.unarchive()
    • JobDefinitionVersions
      • JobDefinitionVersions
        • JobDefinitionVersions.archive()
        • JobDefinitionVersions.create()
        • JobDefinitionVersions.delete()
        • JobDefinitionVersions.get()
        • JobDefinitionVersions.job_definition_id
        • JobDefinitionVersions.job_definition_name
        • JobDefinitionVersions.list()
        • JobDefinitionVersions.organization_id
        • JobDefinitionVersions.unarchive()
        • JobDefinitionVersions.update()
    • Jobs
      • Jobs
        • Jobs.archive()
        • Jobs.create()
        • Jobs.get()
        • Jobs.get_artifacts()
        • Jobs.job_definition_id
        • Jobs.job_definition_name
        • Jobs.list()
        • Jobs.organization_id
        • Jobs.stop()
        • Jobs.unarchive()
        • Jobs.update_statistics()
    • Models
      • Models
        • Models.archive()
        • Models.create()
        • Models.get()
        • Models.get_download_uri()
        • Models.job_definition_id
        • Models.job_definition_name
        • Models.list()
        • Models.organization_id
        • Models.unarchive()
        • Models.update()
  • Subresources
    • Statistics
      • Statistics
        • Statistics.STAGE_TRAIN
        • Statistics.STAGE_VALIDATION
        • Statistics.add_stage()
        • Statistics.from_response()
        • Statistics.get_statistics()
        • Statistics.stages
    • JobStatus
      • JobStatus
    • JobArtifacts
      • JobArtifacts
        • JobArtifacts.download_uri
        • JobArtifacts.from_response()

Usage

from abeja.training import Client, job_status

client = Client()
adapter = client.job_definitions()
definition = adapter.get('flower-classification')

for job in definition.jobs().list():
   if job.status == job_status.COMPLETE:
      print('Job {} was completed!', job.job_id)

Low level API

Low-Level API directly accesses the API endpoint.

• 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.training import APIClient

api = APIClient()
job_definitions = api.get_training_job_definitions(organization_id)

API Mapping

method	path
post	/organizations/<organization_id>/training/definitions	APIClient.create_training_job_definition()
get	/organizations/<organization_id>/training/definitions	APIClient.get_training_job_definitions()
get	/organizations/<organization_id>/training/definitions/<job_definition_name>	APIClient.get_training_job_definition()
post	/organizations/<organization_id>/training/definitions/<job_definition_name>/archive	APIClient.archive_training_job_definition()
post	/organizations/<organization_id>/training/definitions/<job_definition_name>/unarchive	APIClient.unarchive_training_job_definition()
delete	/organizations/<organization_id>/training/definitions/<job_definition_name>	APIClient.delete_training_job_definition()
post	/organizations/<organization_id>/training/definitions/<job_definition_name>/versions	APIClient.create_training_job_definition_version()
get	/organizations/<organization_id>/training/definitions/<job_definition_name>/versions	APIClient.get_training_job_definition_versions()
get	/organizations/<organization_id>/training/definitions/<job_definition_name>/versions/<version_id>	APIClient.get_training_job_definition_version()
patch	/organizations/<organization_id>/training/definitions/<job_definition_name>/versions/<version_id>	APIClient.patch_training_job_definition_version()
delete	/organizations/<organization_id>/training/definitions/<job_definition_name>/versions/<version_id>	APIClient.delete_training_job_definition_version()
post	/organizations/<organization_id>/training/definitions/<job_definition_name>/versions/<version_id>/jobs	APIClient.create_training_job()
get	/organizations/<organization_id>/training/definitions/<job_definition_name>/jobs	APIClient.get_training_jobs()
get	/organizations/<organization_id>/training/definitions/<job_definition_name>/jobs/<training_job_id>	APIClient.get_training_job()
post	/organizations/<organization_id>/training/definitions/<job_definition_name>/jobs/<training_job_id>/stop	APIClient.stop_training_job()
get	/organizations/<organization_id>/training/definitions/<job_definition_name>/jobs/<training_job_id>/result	APIClient.get_training_result()
delete	/organizations/<organization_id>/training/definitions/<job_definition_name>/jobs/<training_job_id>/statistics	APIClient.update_statistics()
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()

Tutorial

• A Sample tutorial
  • Register Training Job Definition, Training Job Definition Version and Training Job.