Skip to content

Latest commit

 

History

History
73 lines (40 loc) · 2.67 KB

object.md

File metadata and controls

73 lines (40 loc) · 2.67 KB
Raw

Object

All system managed objects generally have the following attributes and actions.

Attributes

  • Id

    [String, Required] Id is system generated string, immutable and uniquely identifying an object. System must ensure its uniqueness within given workspace over the lifetime of the worksapce. Usually UUIDs (GUIDs) are used for this.

    Example: 123e4567-e89b-12d3-a456-426655440000

The maximum length is 40 characters.

Note: 40 characters is sufficient to represent either UUID or SHA-1 hashes as human readable strings.

  • Name

    [String, Required]

    Name is string assigned by user, uniquely identifying an object. It's mutable, and can be changed by user as long as it stays unique within specific scope at any moment of time among non-archived objects. Scope is usually workspace, but in some cases uniqueness can be enforced within smaller scope, such as artifact names are unique only within run.

Additional criteria:

  • It should consist of alphanumeric characters, hyphens (-), and underscores (_).
  • It should start with an alphanumeric character.
  • It should not contain spaces or any other special characters.
  • It should be case-insensitive for uniqueness checks.
  • The maximum length is 255 characters.

Examples of valid names:

  • my-dataset

  • model_v1

  • preprocessing_pipeline_2

    • Status

    [Enum, Required]

    Allowed values: Active, Deprecated, Archived

    Not all statuses are applicable to some object types.

    • Active object is visible in default lists, can be retrieved by name or id, and can be used in the system
    • Deprecated object is not visible in default lists, can be retrieved by name or id, and can be used in the system. User might be warned that this object is deprecated and recommended to use some other object instead.
    • Archived object is not visible in default lists, can't be retrieved by name and can't be used to execute new jobs. It can be retrieved by Id, most of metadata is still readable for the purpose of exploring history of past executions.

  • Description

    [String, Optional].

    Arbitrary text description for given object.

The maximum length is 32K characters.

Actions

  • Create

  • Get

  • Archive

    Object is not deleted. Name is can be reused for some other object.

  • Rename

Deletion

Hard deletion is unsupported for system managed objects. Objects can be archived to free up name, and hide object from default lists or UX. However, objects are preserved to allow user later discover history of ML, and prevent breakage of other objects referencing given object