hume 0.6.0 → 0.6.2

package/.mock/definition/custom-models/datasets.yml

@@ -0,0 +1,406 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list-datasets:
+      path: /v0/registry/datasets
+      method: GET
+      auth: true
+      docs: Returns 200 if successful
+      display-name: List datasets
+      request:
+        name: DatasetsListDatasetsRequest
+        query-parameters:
+          name:
+            type: optional<string>
+            docs: Dataset name to be queried
+          page_number:
+            type: optional<integer>
+            docs: Index of the first result
+          page_size:
+            type: optional<integer>
+            docs: Maximum number of results
+          shared_assets:
+            type: optional<boolean>
+            docs: >-
+              `True` Will show all assets owned by you and shared with you.
+              `False` Will show only your assets. Default: `False`
+      response:
+        docs: Success
+        type: root.DatasetPage
+      examples:
+        - response:
+            body:
+              content:
+                - id: id
+                  name: name
+                  latest_version:
+                    id: id
+                    user_id: user_id
+                    labels_file_uri: labels_file_uri
+                    feature_types:
+                      feature_types: CATEGORICAL
+                    dataset_id: dataset_id
+                    dataset_version: 1
+                    created_on: 1
+                  modified_on: 1
+                  metadata:
+                    metadata: {}
+              pageable:
+                offset: 1
+                sort:
+                  empty: true
+                  sorted: true
+                  unsorted: true
+                paged: true
+                unpaged: true
+                page_number: 1
+                page_size: 1
+              total: 1
+              last: true
+              total_elements: 1
+              total_pages: 1
+              size: 1
+              number: 1
+              sort:
+                empty: true
+                sorted: true
+                unsorted: true
+              first: true
+              number_of_elements: 1
+              empty: true
+    create-dataset:
+      path: /v0/registry/datasets
+      method: POST
+      auth: true
+      docs: Returns 201 if successful
+      display-name: Create dataset
+      request:
+        name: DatasetsCreateDatasetRequest
+        body:
+          properties:
+            name:
+              type: string
+              docs: Name of the Dataset to be created
+            feature_types: optional<file>
+            labels_file: file
+        content-type: multipart/form-data
+      response:
+        docs: Success
+        type: root.ReturnDataset
+      examples:
+        - request:
+            name: name
+          response:
+            body:
+              id: id
+              name: name
+              latest_version:
+                id: id
+                user_id: user_id
+                labels_file_uri: labels_file_uri
+                feature_types:
+                  feature_types: CATEGORICAL
+                dataset_id: dataset_id
+                dataset_version: 1
+                created_on: 1
+              modified_on: 1
+              metadata:
+                metadata:
+                  metadata:
+                    key: value
+    get-dataset:
+      path: /v0/registry/datasets/{id}
+      method: GET
+      auth: true
+      docs: Returns 200 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a Dataset
+      display-name: Get dataset
+      response:
+        docs: Success
+        type: root.ReturnDataset
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              id: id
+              name: name
+              latest_version:
+                id: id
+                user_id: user_id
+                labels_file_uri: labels_file_uri
+                feature_types:
+                  feature_types: CATEGORICAL
+                dataset_id: dataset_id
+                dataset_version: 1
+                created_on: 1
+              modified_on: 1
+              metadata:
+                metadata:
+                  metadata:
+                    key: value
+    create-dataset-version:
+      path: /v0/registry/datasets/{id}
+      method: POST
+      auth: true
+      docs: Returns 200 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a Dataset
+      display-name: Create dataset version
+      request:
+        name: DatasetsCreateDatasetVersionRequest
+        body:
+          properties:
+            feature_types: optional<file>
+            labels_file: file
+        content-type: multipart/form-data
+      response:
+        docs: Success
+        type: list<root.ReturnDataset>
+      examples:
+        - path-parameters:
+            id: id
+          request: {}
+          response:
+            body:
+              - id: id
+                name: name
+                latest_version:
+                  id: id
+                  user_id: user_id
+                  labels_file_uri: labels_file_uri
+                  feature_types:
+                    feature_types: CATEGORICAL
+                  dataset_id: dataset_id
+                  dataset_version: 1
+                  created_on: 1
+                modified_on: 1
+                metadata:
+                  metadata: {}
+    delete-dataset:
+      path: /v0/registry/datasets/{id}
+      method: DELETE
+      auth: true
+      docs: Returns 204 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a Dataset
+      display-name: Delete dataset
+      examples:
+        - path-parameters:
+            id: id
+    list-dataset-versions:
+      path: /v0/registry/datasets/{id}/versions
+      method: GET
+      auth: true
+      docs: Returns 200 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a Dataset
+      display-name: List dataset versions
+      request:
+        name: DatasetsListDatasetVersionsRequest
+        query-parameters:
+          page_number:
+            type: optional<integer>
+            docs: Index of the first result
+          page_size:
+            type: optional<integer>
+            docs: Maximum number of results
+          shared_assets:
+            type: optional<boolean>
+            docs: >-
+              `True` Will show all assets owned by you and shared with you.
+              `False` Will show only your assets. Default: `False`
+      response:
+        docs: Success
+        type: root.DatasetVersionPage
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              content:
+                - id: id
+                  user_id: user_id
+                  labels_file_uri: labels_file_uri
+                  feature_types:
+                    feature_types: CATEGORICAL
+                  dataset_id: dataset_id
+                  dataset_version: 1
+                  created_on: 1
+              pageable:
+                offset: 1
+                sort:
+                  empty: true
+                  sorted: true
+                  unsorted: true
+                paged: true
+                unpaged: true
+                page_number: 1
+                page_size: 1
+              total: 1
+              last: true
+              total_elements: 1
+              total_pages: 1
+              size: 1
+              number: 1
+              sort:
+                empty: true
+                sorted: true
+                unsorted: true
+              first: true
+              number_of_elements: 1
+              empty: true
+    list-dataset-files:
+      path: /v0/registry/datasets/{id}/files
+      method: GET
+      auth: true
+      docs: Returns 200 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a Dataset
+      display-name: List dataset files
+      request:
+        name: DatasetsListDatasetFilesRequest
+        query-parameters:
+          page_number:
+            type: optional<integer>
+            docs: Index of the first result
+          page_size:
+            type: optional<integer>
+            docs: Maximum number of results
+          shared_assets:
+            type: optional<boolean>
+            docs: >-
+              `True` Will show all assets owned by you and shared with you.
+              `False` Will show only your assets. Default: `False`
+      response:
+        docs: Success
+        type: list<root.FilePage>
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              - content:
+                  - file:
+                      id: id
+                      user_id: user_id
+                      data_type: data_type
+                      is_sanitized: true
+                      is_owned_by_reader: true
+                pageable:
+                  offset: 1
+                  paged: true
+                  unpaged: true
+                  page_number: 1
+                  page_size: 1
+                total: 1
+                last: true
+                total_elements: 1
+                total_pages: 1
+                size: 1
+                number: 1
+                sort:
+                  empty: true
+                  sorted: true
+                  unsorted: true
+                first: true
+                number_of_elements: 1
+                empty: true
+    get-dataset-version:
+      path: /v0/registry/datasets/version/{id}
+      method: GET
+      auth: true
+      docs: Returns 200 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a Dataset version
+      display-name: Get dataset version
+      response:
+        docs: Success
+        type: root.DatasetLabels
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              id: id
+              user_id: user_id
+              labels_file_uri: labels_file_uri
+              feature_type_json_uri: feature_type_json_uri
+              dataset_id: dataset_id
+              dataset_version: 1
+              created_on: 1
+              is_most_recent_version: true
+    list-dataset-version-files:
+      path: /v0/registry/datasets/version/{id}/files
+      method: GET
+      auth: true
+      docs: Returns 200 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a Dataset version
+      display-name: List dataset version files
+      request:
+        name: DatasetsListDatasetVersionFilesRequest
+        query-parameters:
+          page_number:
+            type: optional<integer>
+            docs: Index of the first result
+          page_size:
+            type: optional<integer>
+            docs: Maximum number of results
+          shared_assets:
+            type: optional<boolean>
+            docs: >-
+              `True` Will show all assets owned by you and shared with you.
+              `False` Will show only your assets. Default: `False`
+      response:
+        docs: Success
+        type: list<root.FilePage>
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              - content:
+                  - file:
+                      id: id
+                      user_id: user_id
+                      data_type: data_type
+                      is_sanitized: true
+                      is_owned_by_reader: true
+                pageable:
+                  offset: 1
+                  paged: true
+                  unpaged: true
+                  page_number: 1
+                  page_size: 1
+                total: 1
+                last: true
+                total_elements: 1
+                total_pages: 1
+                size: 1
+                number: 1
+                sort:
+                  empty: true
+                  sorted: true
+                  unsorted: true
+                first: true
+                number_of_elements: 1
+                empty: true

package/.mock/definition/custom-models/files.yml

@@ -0,0 +1,263 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    list-files:
+      path: /v0/registry/files
+      method: GET
+      auth: true
+      docs: Returns 200 if successful
+      display-name: List files
+      request:
+        name: FilesListFilesRequest
+        query-parameters:
+          page_number:
+            type: optional<integer>
+            docs: Index of the first result
+          page_size:
+            type: optional<integer>
+            docs: Maximum number of results
+          shared_assets:
+            type: optional<boolean>
+            docs: >-
+              `True` Will show all assets owned by you and shared with you.
+              `False` Will show only your assets. Default: `False`
+      response:
+        docs: Success
+        type: root.FilePage
+      examples:
+        - response:
+            body:
+              content:
+                - file:
+                    id: id
+                    user_id: user_id
+                    data_type: data_type
+                    is_sanitized: true
+                    is_owned_by_reader: true
+                  attributes:
+                    - name: name
+                      value: value
+              pageable:
+                offset: 1
+                sort:
+                  empty: true
+                  sorted: true
+                  unsorted: true
+                paged: true
+                unpaged: true
+                page_number: 1
+                page_size: 1
+              total: 1
+              last: true
+              total_elements: 1
+              total_pages: 1
+              size: 1
+              number: 1
+              sort:
+                empty: true
+                sorted: true
+                unsorted: true
+              first: true
+              number_of_elements: 1
+              empty: true
+    create-files:
+      path: /v0/registry/files
+      method: POST
+      auth: true
+      docs: Returns 201 if successful
+      display-name: Create files
+      request:
+        body:
+          docs: List of Files with Attributes to be created
+          type: list<root.FileWithAttributesInput>
+      response:
+        docs: Success
+        type: list<root.FileWithAttributes>
+      examples:
+        - request:
+            - file:
+                name: name
+                hume_storage: true
+                data_type: data_type
+          response:
+            body:
+              - file:
+                  id: id
+                  name: name
+                  uri: uri
+                  upload_uri: upload_uri
+                  thumbnail_uri: thumbnail_uri
+                  user_id: user_id
+                  data_type: data_type
+                  created_on: 1
+                  modified_on: 1
+                  metadata:
+                    metadata: {}
+                  hume_storage: true
+                  hume_storage_upload_timestamp: 1
+                  is_sanitized: true
+                  is_owned_by_reader: true
+                  is_linked_to_publicly_shared: true
+                  is_linked_to_hume_model: true
+                attributes:
+                  - name: name
+                    value: value
+    upload-file:
+      path: /v0/registry/files/upload
+      method: POST
+      auth: true
+      docs: >-
+        Upload a file synchronously. Returns 201 if successful. Files must have
+        a name. Files must specify Content-Type. Request bodies, and therefore
+        files, are limited to 100MB
+      display-name: Upload file
+      request:
+        name: FilesUploadFileRequest
+        body:
+          properties:
+            file: file
+            attributes: optional<file>
+        content-type: multipart/form-data
+      response:
+        docs: Success
+        type: root.FileWithAttributes
+      examples:
+        - request: {}
+          response:
+            body:
+              file:
+                id: id
+                name: name
+                uri: uri
+                upload_uri: upload_uri
+                thumbnail_uri: thumbnail_uri
+                user_id: user_id
+                data_type: data_type
+                created_on: 1
+                modified_on: 1
+                metadata:
+                  metadata: {}
+                hume_storage: true
+                hume_storage_upload_timestamp: 1
+                is_sanitized: true
+                is_owned_by_reader: true
+                is_linked_to_publicly_shared: true
+                is_linked_to_hume_model: true
+              attributes:
+                - name: name
+                  value: value
+    get-file:
+      path: /v0/registry/files/{id}
+      method: GET
+      auth: true
+      docs: Returns 200 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a File
+      display-name: Get file
+      response:
+        docs: Success
+        type: root.FileWithAttributes
+      examples:
+        - path-parameters:
+            id: id
+          response:
+            body:
+              file:
+                id: id
+                name: name
+                uri: uri
+                upload_uri: upload_uri
+                thumbnail_uri: thumbnail_uri
+                user_id: user_id
+                data_type: data_type
+                created_on: 1
+                modified_on: 1
+                metadata:
+                  metadata: {}
+                hume_storage: true
+                hume_storage_upload_timestamp: 1
+                is_sanitized: true
+                is_owned_by_reader: true
+                is_linked_to_publicly_shared: true
+                is_linked_to_hume_model: true
+              attributes:
+                - name: name
+                  value: value
+    delete-file:
+      path: /v0/registry/files/{id}
+      method: DELETE
+      auth: true
+      docs: Returns 204 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a File
+      display-name: Delete file
+      examples:
+        - path-parameters:
+            id: id
+    update-file-name:
+      path: /v0/registry/files/{id}
+      method: PATCH
+      auth: true
+      docs: Returns 200 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a File
+      display-name: Update file name
+      request:
+        name: FilesUpdateFileNameRequest
+        query-parameters:
+          name:
+            type: string
+            docs: New File name
+      response:
+        docs: Success
+        type: root.FileWithAttributes
+      examples:
+        - path-parameters:
+            id: id
+          query-parameters:
+            name: name
+          response:
+            body:
+              file:
+                id: id
+                name: name
+                uri: uri
+                upload_uri: upload_uri
+                thumbnail_uri: thumbnail_uri
+                user_id: user_id
+                data_type: data_type
+                created_on: 1
+                modified_on: 1
+                metadata:
+                  metadata: {}
+                hume_storage: true
+                hume_storage_upload_timestamp: 1
+                is_sanitized: true
+                is_owned_by_reader: true
+                is_linked_to_publicly_shared: true
+                is_linked_to_hume_model: true
+              attributes:
+                - name: name
+                  value: value
+    get-file-predictions:
+      path: /v0/registry/files/{id}/predictions
+      method: GET
+      auth: true
+      docs: Returns 200 if successful
+      path-parameters:
+        id:
+          type: string
+          docs: Hume-generated ID of a File
+      display-name: Get file predictions
+      examples:
+        - path-parameters:
+            id: id

package/.mock/definition/custom-models/jobs.yml

@@ -0,0 +1,44 @@
+imports:
+  root: __package__.yml
+service:
+  auth: false
+  base-path: ''
+  endpoints:
+    start-training-job:
+      path: /v0/registry/v0/batch/jobs/tl/train
+      method: POST
+      auth: true
+      docs: Start a new custom models training job.
+      display-name: Start training job
+      request:
+        body: root.TrainingBaseRequest
+      response:
+        docs: ''
+        type: root.JobId
+      examples:
+        - request:
+            custom_model:
+              name: name
+            dataset:
+              id: id
+          response:
+            body:
+              job_id: job_id
+    start-custom-models-inference-job:
+      path: /v0/registry/v0/batch/jobs/tl/inference
+      method: POST
+      auth: true
+      docs: Start a new custom models inference job.
+      display-name: Start custom models inference job
+      request:
+        body: root.TlInferenceBaseRequest
+      response:
+        docs: ''
+        type: root.JobId
+      examples:
+        - request:
+            custom_model:
+              id: id
+          response:
+            body:
+              job_id: job_id