@mlhub/models-ts-sdk 0.0.0

package/src/models/ModelIO.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * MLHub Models API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ModelIO
+ */
+export interface ModelIO {
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelIO
+     */
+    data_type?: string | null;
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof ModelIO
+     */
+    shape?: Array<number> | null;
+}
+
+export function ModelIOFromJSON(json: any): ModelIO {
+    return ModelIOFromJSONTyped(json, false);
+}
+
+export function ModelIOFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelIO {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'data_type': !exists(json, 'data_type') ? undefined : json['data_type'],
+        'shape': !exists(json, 'shape') ? undefined : json['shape'],
+    };
+}
+
+export function ModelIOToJSON(value?: ModelIO | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'data_type': value.data_type,
+        'shape': value.shape,
+    };
+}
+

package/src/models/ModelMetadata.ts

@@ -0,0 +1,348 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * MLHub Models API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    HardwareRequirements,
+    HardwareRequirementsFromJSON,
+    HardwareRequirementsFromJSONTyped,
+    HardwareRequirementsToJSON,
+    ModelIO,
+    ModelIOFromJSON,
+    ModelIOFromJSONTyped,
+    ModelIOToJSON,
+} from './';
+
+/**
+ * 
+ * @export
+ * @interface ModelMetadata
+ */
+export interface ModelMetadata {
+    /**
+     * 
+     * @type {any}
+     * @memberof ModelMetadata
+     */
+    annotation?: any | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelMetadata
+     */
+    bias_evaluation_score?: number | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ModelMetadata
+     */
+    edge_optimized?: boolean | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ModelMetadata
+     */
+    finetuning_datasets?: Array<string> | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelMetadata
+     */
+    framework?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelMetadata
+     */
+    image?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ModelMetadata
+     */
+    inference_distributed?: boolean | null;
+    /**
+     * 
+     * @type {HardwareRequirements}
+     * @memberof ModelMetadata
+     */
+    inference_hardware?: HardwareRequirements | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelMetadata
+     */
+    inference_max_compute_utilization_percentage?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelMetadata
+     */
+    inference_max_energy_consumption_watts?: number | null;
+    /**
+     * Inference performance fields
+     * @type {number}
+     * @memberof ModelMetadata
+     */
+    inference_max_latency_ms?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelMetadata
+     */
+    inference_max_memory_usage_mb?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof ModelMetadata
+     */
+    inference_min_throughput?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelMetadata
+     */
+    inference_precision?: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ModelMetadata
+     */
+    inference_software_dependencies?: Array<string> | null;
+    /**
+     * Arbitrary labels
+     * @type {Array<string>}
+     * @memberof ModelMetadata
+     */
+    keywords?: Array<string> | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelMetadata
+     */
+    license?: string | null;
+    /**
+     * 
+     * @type {Array<ModelIO>}
+     * @memberof ModelMetadata
+     */
+    model_inputs?: Array<ModelIO> | null;
+    /**
+     * 
+     * @type {Array<ModelIO>}
+     * @memberof ModelMetadata
+     */
+    model_outputs?: Array<ModelIO> | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelMetadata
+     */
+    model_type?: string | null;
+    /**
+     * Architecture fields
+     * @type {boolean}
+     * @memberof ModelMetadata
+     */
+    multi_modal?: boolean | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelMetadata
+     */
+    name?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ModelMetadata
+     */
+    pretrained?: boolean | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ModelMetadata
+     */
+    pretraining_datasets?: Array<string> | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ModelMetadata
+     */
+    pruned?: boolean | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ModelMetadata
+     */
+    quantization_aware?: boolean | null;
+    /**
+     * Regulatory and Compliance Fields
+     * A vector or strings that represent regulatory standards. Ex HIPPA
+     * @type {Array<string>}
+     * @memberof ModelMetadata
+     */
+    regulatory?: Array<string> | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ModelMetadata
+     */
+    slimmed?: boolean | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ModelMetadata
+     */
+    supports_quantization?: boolean | null;
+    /**
+     * Inference Fields
+     * @type {Array<string>}
+     * @memberof ModelMetadata
+     */
+    task_types?: Array<string> | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ModelMetadata
+     */
+    training_distributed?: boolean | null;
+    /**
+     * 
+     * @type {HardwareRequirements}
+     * @memberof ModelMetadata
+     */
+    training_hardware?: HardwareRequirements | null;
+    /**
+     * Training performance fields
+     * @type {number}
+     * @memberof ModelMetadata
+     */
+    training_max_energy_consumption_watts?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelMetadata
+     */
+    training_precision?: string | null;
+    /**
+     * Training-related Fields
+     * @type {number}
+     * @memberof ModelMetadata
+     */
+    training_time?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ModelMetadata
+     */
+    version?: string | null;
+}
+
+export function ModelMetadataFromJSON(json: any): ModelMetadata {
+    return ModelMetadataFromJSONTyped(json, false);
+}
+
+export function ModelMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelMetadata {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'annotation': !exists(json, 'annotation') ? undefined : json['annotation'],
+        'bias_evaluation_score': !exists(json, 'bias_evaluation_score') ? undefined : json['bias_evaluation_score'],
+        'edge_optimized': !exists(json, 'edge_optimized') ? undefined : json['edge_optimized'],
+        'finetuning_datasets': !exists(json, 'finetuning_datasets') ? undefined : json['finetuning_datasets'],
+        'framework': !exists(json, 'framework') ? undefined : json['framework'],
+        'image': !exists(json, 'image') ? undefined : json['image'],
+        'inference_distributed': !exists(json, 'inference_distributed') ? undefined : json['inference_distributed'],
+        'inference_hardware': !exists(json, 'inference_hardware') ? undefined : HardwareRequirementsFromJSON(json['inference_hardware']),
+        'inference_max_compute_utilization_percentage': !exists(json, 'inference_max_compute_utilization_percentage') ? undefined : json['inference_max_compute_utilization_percentage'],
+        'inference_max_energy_consumption_watts': !exists(json, 'inference_max_energy_consumption_watts') ? undefined : json['inference_max_energy_consumption_watts'],
+        'inference_max_latency_ms': !exists(json, 'inference_max_latency_ms') ? undefined : json['inference_max_latency_ms'],
+        'inference_max_memory_usage_mb': !exists(json, 'inference_max_memory_usage_mb') ? undefined : json['inference_max_memory_usage_mb'],
+        'inference_min_throughput': !exists(json, 'inference_min_throughput') ? undefined : json['inference_min_throughput'],
+        'inference_precision': !exists(json, 'inference_precision') ? undefined : json['inference_precision'],
+        'inference_software_dependencies': !exists(json, 'inference_software_dependencies') ? undefined : json['inference_software_dependencies'],
+        'keywords': !exists(json, 'keywords') ? undefined : json['keywords'],
+        'license': !exists(json, 'license') ? undefined : json['license'],
+        'model_inputs': !exists(json, 'model_inputs') ? undefined : (json['model_inputs'] === null ? null : (json['model_inputs'] as Array<any>).map(ModelIOFromJSON)),
+        'model_outputs': !exists(json, 'model_outputs') ? undefined : (json['model_outputs'] === null ? null : (json['model_outputs'] as Array<any>).map(ModelIOFromJSON)),
+        'model_type': !exists(json, 'model_type') ? undefined : json['model_type'],
+        'multi_modal': !exists(json, 'multi_modal') ? undefined : json['multi_modal'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'pretrained': !exists(json, 'pretrained') ? undefined : json['pretrained'],
+        'pretraining_datasets': !exists(json, 'pretraining_datasets') ? undefined : json['pretraining_datasets'],
+        'pruned': !exists(json, 'pruned') ? undefined : json['pruned'],
+        'quantization_aware': !exists(json, 'quantization_aware') ? undefined : json['quantization_aware'],
+        'regulatory': !exists(json, 'regulatory') ? undefined : json['regulatory'],
+        'slimmed': !exists(json, 'slimmed') ? undefined : json['slimmed'],
+        'supports_quantization': !exists(json, 'supports_quantization') ? undefined : json['supports_quantization'],
+        'task_types': !exists(json, 'task_types') ? undefined : json['task_types'],
+        'training_distributed': !exists(json, 'training_distributed') ? undefined : json['training_distributed'],
+        'training_hardware': !exists(json, 'training_hardware') ? undefined : HardwareRequirementsFromJSON(json['training_hardware']),
+        'training_max_energy_consumption_watts': !exists(json, 'training_max_energy_consumption_watts') ? undefined : json['training_max_energy_consumption_watts'],
+        'training_precision': !exists(json, 'training_precision') ? undefined : json['training_precision'],
+        'training_time': !exists(json, 'training_time') ? undefined : json['training_time'],
+        'version': !exists(json, 'version') ? undefined : json['version'],
+    };
+}
+
+export function ModelMetadataToJSON(value?: ModelMetadata | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'annotation': value.annotation,
+        'bias_evaluation_score': value.bias_evaluation_score,
+        'edge_optimized': value.edge_optimized,
+        'finetuning_datasets': value.finetuning_datasets,
+        'framework': value.framework,
+        'image': value.image,
+        'inference_distributed': value.inference_distributed,
+        'inference_hardware': HardwareRequirementsToJSON(value.inference_hardware),
+        'inference_max_compute_utilization_percentage': value.inference_max_compute_utilization_percentage,
+        'inference_max_energy_consumption_watts': value.inference_max_energy_consumption_watts,
+        'inference_max_latency_ms': value.inference_max_latency_ms,
+        'inference_max_memory_usage_mb': value.inference_max_memory_usage_mb,
+        'inference_min_throughput': value.inference_min_throughput,
+        'inference_precision': value.inference_precision,
+        'inference_software_dependencies': value.inference_software_dependencies,
+        'keywords': value.keywords,
+        'license': value.license,
+        'model_inputs': value.model_inputs === undefined ? undefined : (value.model_inputs === null ? null : (value.model_inputs as Array<any>).map(ModelIOToJSON)),
+        'model_outputs': value.model_outputs === undefined ? undefined : (value.model_outputs === null ? null : (value.model_outputs as Array<any>).map(ModelIOToJSON)),
+        'model_type': value.model_type,
+        'multi_modal': value.multi_modal,
+        'name': value.name,
+        'pretrained': value.pretrained,
+        'pretraining_datasets': value.pretraining_datasets,
+        'pruned': value.pruned,
+        'quantization_aware': value.quantization_aware,
+        'regulatory': value.regulatory,
+        'slimmed': value.slimmed,
+        'supports_quantization': value.supports_quantization,
+        'task_types': value.task_types,
+        'training_distributed': value.training_distributed,
+        'training_hardware': HardwareRequirementsToJSON(value.training_hardware),
+        'training_max_energy_consumption_watts': value.training_max_energy_consumption_watts,
+        'training_precision': value.training_precision,
+        'training_time': value.training_time,
+        'version': value.version,
+    };
+}
+

package/src/models/NotFoundResponse.ts

@@ -0,0 +1,88 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * MLHub Models API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface NotFoundResponse
+ */
+export interface NotFoundResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof NotFoundResponse
+     */
+    message: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof NotFoundResponse
+     */
+    metadata: object;
+    /**
+     * 
+     * @type {any}
+     * @memberof NotFoundResponse
+     */
+    result: any | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof NotFoundResponse
+     */
+    status: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof NotFoundResponse
+     */
+    version: string;
+}
+
+export function NotFoundResponseFromJSON(json: any): NotFoundResponse {
+    return NotFoundResponseFromJSONTyped(json, false);
+}
+
+export function NotFoundResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): NotFoundResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        'metadata': json['metadata'],
+        'result': json['result'],
+        'status': json['status'],
+        'version': json['version'],
+    };
+}
+
+export function NotFoundResponseToJSON(value?: NotFoundResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'message': value.message,
+        'metadata': value.metadata,
+        'result': value.result,
+        'status': value.status,
+        'version': value.version,
+    };
+}
+

package/src/models/Platform.ts

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * MLHub Models API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Represents a platform for which there are clients registered for one or more of
+ * the following APIs: Models, Datasets, Inference, Training. The strum(serialize="")
+ * attribute corresponds to the desired "platform" path parameter passed to the
+ * `get_client` method of a registrar.
+ * @export
+ * @enum {string}
+ */
+export enum Platform {
+    Huggingface = 'huggingface',
+    Github = 'github',
+    Git = 'git',
+    Patra = 'patra',
+    TaccTapis = 'tacc-tapis',
+    S3 = 's3'
+}
+
+export function PlatformFromJSON(json: any): Platform {
+    return PlatformFromJSONTyped(json, false);
+}
+
+export function PlatformFromJSONTyped(json: any, ignoreDiscriminator: boolean): Platform {
+    return json as Platform;
+}
+
+export function PlatformToJSON(value?: Platform | null): any {
+    return value as any;
+}
+

package/src/models/PlatformDetails.ts

@@ -0,0 +1,71 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * MLHub Models API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    Platform,
+    PlatformFromJSON,
+    PlatformFromJSONTyped,
+    PlatformToJSON,
+} from './';
+
+/**
+ * 
+ * @export
+ * @interface PlatformDetails
+ */
+export interface PlatformDetails {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof PlatformDetails
+     */
+    capabilities: Array<string>;
+    /**
+     * 
+     * @type {Platform}
+     * @memberof PlatformDetails
+     */
+    name: Platform;
+}
+
+export function PlatformDetailsFromJSON(json: any): PlatformDetails {
+    return PlatformDetailsFromJSONTyped(json, false);
+}
+
+export function PlatformDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PlatformDetails {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'capabilities': json['capabilities'],
+        'name': PlatformFromJSON(json['name']),
+    };
+}
+
+export function PlatformDetailsToJSON(value?: PlatformDetails | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'capabilities': value.capabilities,
+        'name': PlatformToJSON(value.name),
+    };
+}
+

package/src/models/PublishArtifactRequest.ts

@@ -0,0 +1,64 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * MLHub Models API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 0.1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface PublishArtifactRequest
+ */
+export interface PublishArtifactRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof PublishArtifactRequest
+     */
+    target_platform: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof PublishArtifactRequest
+     */
+    webhook_url?: string | null;
+}
+
+export function PublishArtifactRequestFromJSON(json: any): PublishArtifactRequest {
+    return PublishArtifactRequestFromJSONTyped(json, false);
+}
+
+export function PublishArtifactRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): PublishArtifactRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'target_platform': json['target_platform'],
+        'webhook_url': !exists(json, 'webhook_url') ? undefined : json['webhook_url'],
+    };
+}
+
+export function PublishArtifactRequestToJSON(value?: PublishArtifactRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'target_platform': value.target_platform,
+        'webhook_url': value.webhook_url,
+    };
+}
+