runbios-sdk 0.2.6 → 0.2.7-dev.205

package/README.md

@@ -320,8 +320,14 @@ const job = await client.training.create(request);
 const jobs = await client.training.list({ status: 'running' });
 const page = await client.training.listPage({ limit: 50, offset: 0 });
 
-// Get metrics
-const metrics = await client.training.getMetrics('job_abc123');
+// Get a compact, model-readable report (metric averages/ranges/best steps and GPU averages/peaks)
+const report = await client.training.getMetrics('job_abc123', { view: 'summary' });
+for (const metric of report.metric_summaries ?? []) {
+  console.log(metric.label, metric.latest, metric.average, metric.best);
+}
+
+// Request a bounded curve only when you need its shape
+const metrics = await client.training.getMetrics('job_abc123', { view: 'series', maxPoints: 200 });
 for (const point of metrics.metrics) console.log(point.step, point.loss);
 
 // Get checkpoints

package/dist/client.js

@@ -340,7 +340,7 @@ export class HttpClient {
     constructor(config) {
         // Default host stays api.runbios.ai for now; cutover to api.runbios.ai is
         // planned once its DNS exists.
-        this.baseUrl = (config.baseUrl || envBaseUrl() || 'https://api.runbios.ai').replace(/\/+$/, '');
+        this.baseUrl = (config.baseUrl || envBaseUrl() || 'https://api-dev.runbios.ai').replace(/\/+$/, '');
         this.apiKey = config.apiKey ?? envApiKey();
         this.accessToken = config.accessToken;
         this.orgId = config.orgId;

package/dist/index.d.ts

@@ -36,7 +36,7 @@ import { Loop } from './resources/loop.js';
  * SDK version. Sent as part of the User-Agent header.
  * Must match package.json "version" -- enforced by a contract test.
  */
-export declare const VERSION = "0.2.6";
+export declare const VERSION = "0.2.7-dev.205";
 export declare class RunBiOS {
     /** Search models, fetch configs, check adapter compatibility. */
     readonly models: Models;

package/dist/index.js

@@ -36,7 +36,7 @@ import { Loop } from './resources/loop.js';
  * SDK version. Sent as part of the User-Agent header.
  * Must match package.json "version" -- enforced by a contract test.
  */
-export const VERSION = '0.2.6';
+export const VERSION = '0.2.7-dev.205';
 export class RunBiOS {
     /** Search models, fetch configs, check adapter compatibility. */
     models;

package/dist/resources/datasets.d.ts

@@ -1,5 +1,5 @@
 import type { HttpClient } from '../client.js';
-import type { Dataset, DatasetListParams, DatasetListResponse, DatasetUploadParams, DatasetPreview, DatasetPreviewParams, DatasetImportHFParams, DatasetRegisterHFParams, DatasetHubSearchParams, DatasetHubPreviewParams, DatasetValidation, DatasetFormatSpecs, DatasetStorageUsage } from '../types.js';
+import type { Dataset, DatasetListParams, DatasetListResponse, DatasetUploadParams, DatasetPreview, DatasetPreviewParams, DatasetImportHFParams, DatasetRegisterHFParams, DatasetRegisterLoopParams, DatasetHubSearchParams, DatasetHubPreviewParams, DatasetValidation, DatasetFormatSpecs, DatasetStorageUsage } from '../types.js';
 /**
  * Manage training datasets -- upload files, import from HuggingFace,
  * preview contents, and manage storage.
@@ -9,7 +9,7 @@ export declare class Datasets {
     /** @internal */
     constructor(_http: HttpClient);
     /**
-     * List datasets in the current organization/workspace.
+     * List ready datasets by default. Request processing, failed, or all explicitly.
      *
      * @example
      * ```ts
@@ -118,6 +118,30 @@ export declare class Datasets {
      * ```
      */
     registerHuggingFace(params: DatasetRegisterHFParams | Record<string, unknown>): Promise<Dataset>;
+    /**
+     * Turn a curated Conscious Loop set into a dataset training can use.
+     *
+     * Without this, using a loop set from code meant downloading the JSONL and
+     * uploading it again as an unrelated dataset. That works, and it throws away
+     * the one thing that made the set worth having: which conversations, which
+     * verdicts and which judges produced it. Registering keeps that link.
+     *
+     * The set is then put through the SAME validation every uploaded dataset
+     * gets, so it comes back `processing` rather than ready -- poll
+     * {@link getStatus} before training on it. Registering the same set and split
+     * twice is refused rather than billed twice, and an empty set is refused
+     * rather than registered as something that would fail inside the trainer.
+     *
+     * @example
+     * ```ts
+     * const train = await client.datasets.registerLoop({
+     *   loopDatasetId: 'd244894c-7ab4-4b3d-bfda-e0bb4c563ceb',
+     *   name: 'extract-v1 distill SFT',
+     *   split: 'train',
+     * });
+     * ```
+     */
+    registerLoop(params: DatasetRegisterLoopParams | Record<string, unknown>): Promise<Dataset>;
     /**
      * Get the processing status of a dataset.
      *

package/dist/resources/datasets.js

@@ -25,7 +25,7 @@ export class Datasets {
         this._http = _http;
     }
     /**
-     * List datasets in the current organization/workspace.
+     * List ready datasets by default. Request processing, failed, or all explicitly.
      *
      * @example
      * ```ts
@@ -43,8 +43,7 @@ export class Datasets {
             q.set('workspace_id', params.workspaceId);
         if (params.datasetType)
             q.set('dataset_type', params.datasetType);
-        if (params.status)
-            q.set('status', params.status);
+        q.set('status', params.status ?? 'ready');
         if (params.query)
             q.set('q', params.query);
         if (params.sort)
@@ -260,6 +259,45 @@ export class Datasets {
         });
         return normalizeDataset(result);
     }
+    /**
+     * Turn a curated Conscious Loop set into a dataset training can use.
+     *
+     * Without this, using a loop set from code meant downloading the JSONL and
+     * uploading it again as an unrelated dataset. That works, and it throws away
+     * the one thing that made the set worth having: which conversations, which
+     * verdicts and which judges produced it. Registering keeps that link.
+     *
+     * The set is then put through the SAME validation every uploaded dataset
+     * gets, so it comes back `processing` rather than ready -- poll
+     * {@link getStatus} before training on it. Registering the same set and split
+     * twice is refused rather than billed twice, and an empty set is refused
+     * rather than registered as something that would fail inside the trainer.
+     *
+     * @example
+     * ```ts
+     * const train = await client.datasets.registerLoop({
+     *   loopDatasetId: 'd244894c-7ab4-4b3d-bfda-e0bb4c563ceb',
+     *   name: 'extract-v1 distill SFT',
+     *   split: 'train',
+     * });
+     * ```
+     */
+    async registerLoop(params) {
+        const raw = params;
+        const loopDatasetId = String(raw.loopDatasetId || raw.loop_dataset_id || '');
+        if (!loopDatasetId)
+            throw new Error('RunBiOS: loopDatasetId is required');
+        const workspaceId = String(raw.workspaceId || raw.workspace_id || '')
+            || this._http.workspaceId
+            || await this._http.resolveWorkspaceId();
+        const result = await this._http.fetchPost('/api/datasets/register-loop', {
+            loop_dataset_id: loopDatasetId,
+            workspace_id: workspaceId,
+            split: raw.split ?? 'all',
+            ...(raw.name !== undefined && { name: raw.name }),
+        });
+        return normalizeDataset(result);
+    }
     /**
      * Get the processing status of a dataset.
      *

package/dist/resources/inference.js

@@ -326,7 +326,7 @@ export class Inference {
         this.key = config.inferenceKey || envInferenceKey() || envApiKey();
         // Same default host as HttpClient (api.runbios.ai); api.runbios.ai cutover
         // is planned once its DNS exists — update both call sites together.
-        this.baseUrl = (config.baseUrl || envBaseUrl() || 'https://api.runbios.ai').replace(/\/+$/, '');
+        this.baseUrl = (config.baseUrl || envBaseUrl() || 'https://api-dev.runbios.ai').replace(/\/+$/, '');
         this.timeout = config.timeout ?? 900_000;
         this._http = http;
     }

package/dist/resources/training.d.ts

@@ -1,5 +1,5 @@
 import type { HttpClient } from '../client.js';
-import type { TrainingCreateParams, TrainingListParams, TrainingJob, TrainingListResponse, TrainingMetrics, TrainingCheckpoint, TrainingLogs, TrainingStopResponse, TrainingResumeResponse, TrainingPreflightResponse, TrainingRecommendParams, TrainingAdvisorVerdict, TrainingCapabilities } from '../types.js';
+import type { TrainingCreateParams, TrainingListParams, TrainingJob, TrainingListResponse, TrainingMetrics, TrainingMetricsOptions, TrainingCheckpoint, TrainingLogs, TrainingStopResponse, TrainingResumeResponse, TrainingPreflightResponse, TrainingRecommendParams, TrainingAdvisorVerdict, TrainingCapabilities } from '../types.js';
 /**
  * Create, monitor, and manage fine-tuning training jobs.
  */
@@ -93,15 +93,17 @@ export declare class Training {
      * Get training metrics (loss curves, learning rate, throughput) for a job.
      *
      * @param id - Training job ID.
+     * @param options - Choose semantic summaries, a bounded series, or the backward-compatible full rows.
      *
      * @example
      * ```ts
-     * const metrics = await client.training.getMetrics('job_abc123');
-     * console.log(`Current loss: ${metrics.metrics.at(-1)?.loss}`);
-     * console.log(`${metrics.metrics.length} metric points`);
+     * const report = await client.training.getMetrics('job_abc123', { view: 'summary' });
+     * console.log(report.metric_summaries?.find(metric => metric.key === 'loss'));
+     * const curve = await client.training.getMetrics('job_abc123', { view: 'series', maxPoints: 200 });
+     * console.log(`${curve.metrics.length} bounded metric points`);
      * ```
      */
-    getMetrics(id: string): Promise<TrainingMetrics>;
+    getMetrics(id: string, options?: TrainingMetricsOptions): Promise<TrainingMetrics>;
     /**
      * List checkpoints saved during training.
      *

package/dist/resources/training.js

@@ -343,20 +343,38 @@ export class Training {
      * Get training metrics (loss curves, learning rate, throughput) for a job.
      *
      * @param id - Training job ID.
+     * @param options - Choose semantic summaries, a bounded series, or the backward-compatible full rows.
      *
      * @example
      * ```ts
-     * const metrics = await client.training.getMetrics('job_abc123');
-     * console.log(`Current loss: ${metrics.metrics.at(-1)?.loss}`);
-     * console.log(`${metrics.metrics.length} metric points`);
+     * const report = await client.training.getMetrics('job_abc123', { view: 'summary' });
+     * console.log(report.metric_summaries?.find(metric => metric.key === 'loss'));
+     * const curve = await client.training.getMetrics('job_abc123', { view: 'series', maxPoints: 200 });
+     * console.log(`${curve.metrics.length} bounded metric points`);
      * ```
      */
-    async getMetrics(id) {
-        const result = await this._http.fetchGet(`/api/training/jobs/${encodeURIComponent(id)}/metrics`);
+    async getMetrics(id, options = {}) {
+        if (options.maxPoints !== undefined && (!Number.isInteger(options.maxPoints) || options.maxPoints < 1 || options.maxPoints > 1000)) {
+            throw new Error('RunBiOS: maxPoints must be an integer between 1 and 1000');
+        }
+        const query = new URLSearchParams();
+        if (options.view)
+            query.set('view', options.view);
+        if (options.maxPoints !== undefined)
+            query.set('max_points', String(options.maxPoints));
+        const encodedQuery = query.toString();
+        const suffix = encodedQuery ? `?${encodedQuery}` : '';
+        const result = await this._http.fetchGet(`/api/training/jobs/${encodeURIComponent(id)}/metrics${suffix}`);
         const metrics = Array.isArray(result.metrics)
             ? result.metrics
             : Array.isArray(result.steps) ? result.steps : [];
-        return { ...result, metrics, graph_configs: result.graph_configs || [], steps: metrics };
+        return {
+            ...result,
+            metrics,
+            graph_configs: result.graph_configs || [],
+            metric_summaries: result.metric_summaries || [],
+            steps: metrics,
+        };
     }
     /**
      * List checkpoints saved during training.

package/dist/types.d.ts

@@ -8,13 +8,13 @@ export interface BiOSConfig {
     orgId?: string;
     /** Workspace ID. Optional when using API keys (resolved from the key). Can override for multi-workspace keys. */
     workspaceId?: string;
-    /** Base URL for the API. Falls back to the RUNBIOS_BASE_URL environment variable (legacy: BIOS_BASE_URL), then the canonical https://api.runbios.ai hostname. */
+    /** Base URL for the API. Falls back to the RUNBIOS_BASE_URL environment variable (legacy: BIOS_BASE_URL), then the canonical https://api-dev.runbios.ai hostname. */
     baseUrl?: string;
     /** Request timeout in milliseconds. Defaults to 30000. */
     timeout?: number;
     /** Default per-deployment inference key. Can be overridden per inference call. */
     inferenceKey?: string;
-    /** Inference base URL. Defaults to baseUrl, then https://api.runbios.ai. */
+    /** Inference base URL. Defaults to baseUrl, then https://api-dev.runbios.ai. */
     inferenceBaseUrl?: string;
     /** End-to-end inference timeout in milliseconds. Defaults to 15 minutes. */
     inferenceTimeout?: number;
@@ -347,8 +347,8 @@ export interface DatasetListParams {
     workspaceId?: string;
     /** Filter by dataset type. */
     datasetType?: string;
-    /** Lifecycle bucket: ready, processing, or failed. */
-    status?: 'ready' | 'processing' | 'failed';
+    /** Lifecycle bucket. Defaults to ready; all is an explicit diagnostic view. */
+    status?: 'ready' | 'processing' | 'failed' | 'all';
     /** Case-insensitive name search. */
     query?: string;
     /** Server-side ordering. */
@@ -444,6 +444,21 @@ export interface DatasetRegisterHFParams {
     columnMapping?: Record<string, string>;
     importMode?: 'auto' | 'reference' | 'materialize';
 }
+/** Parameters for registering a curated Conscious Loop set as a dataset. */
+export interface DatasetRegisterLoopParams {
+    /** The Conscious Loop dataset to register. */
+    loopDatasetId: string;
+    /** Defaults to `loop-<first 8 of the loop id>`. */
+    name?: string;
+    /**
+     * Which rows to take. Defaults to `all`, because the loop already split the
+     * set by TIME and re-splitting a deliberate split throws that decision away.
+     * Register `train` and `holdout` separately to score a training job against
+     * the loop's own held-back rows; both can exist at once.
+     */
+    split?: 'all' | 'train' | 'holdout';
+    workspaceId?: string;
+}
 /** Parameters for searching HuggingFace Hub datasets. */
 export interface DatasetHubSearchParams {
     /** Search query. */
@@ -822,13 +837,93 @@ export interface TrainingResourceMetrics {
     disk_total_gib: number | null;
     gpus: TrainingDeviceMetrics[];
 }
+export interface TrainingResourceValueSummary {
+    average: number;
+    peak: number;
+    samples: number;
+}
+export interface TrainingDeviceResourceSummary {
+    memory_used_mib: TrainingResourceValueSummary | null;
+    memory_total_mib: number | null;
+    utilization_pct: TrainingResourceValueSummary | null;
+    temperature_c: TrainingResourceValueSummary | null;
+}
+export interface TrainingResourceSummary {
+    scope: 'attempt';
+    aggregation: 'sample_mean';
+    sample_count: number;
+    first_sampled_at: string | null;
+    last_sampled_at: string | null;
+    gpu_count: number | null;
+    gpu_memory_used_mib: TrainingResourceValueSummary | null;
+    gpu_memory_total_mib: number | null;
+    gpu_utilization_pct: TrainingResourceValueSummary | null;
+    gpu_temperature_c: TrainingResourceValueSummary | null;
+    host_ram_used_gib: TrainingResourceValueSummary | null;
+    host_ram_limit_gib: number | null;
+    host_ram_pct: TrainingResourceValueSummary | null;
+    host_cpu_usage_pct: TrainingResourceValueSummary | null;
+    host_cpu_limit_cores: number | null;
+    disk_used_gib: TrainingResourceValueSummary | null;
+    disk_total_gib: number | null;
+    gpus: TrainingDeviceResourceSummary[];
+}
+export interface TrainingMetricSummary {
+    key: string;
+    label: string;
+    unit: string;
+    goal: 'minimize' | 'maximize' | 'schedule' | 'progress' | 'observe' | string;
+    points: number;
+    first: number;
+    latest: number;
+    minimum: number;
+    maximum: number;
+    average: number;
+    change: number;
+    change_percent?: number;
+    first_step: number;
+    last_step: number;
+    best?: number;
+    best_step?: number;
+}
+export interface TrainingSeriesMeta {
+    view: 'full' | 'series' | 'summary';
+    x_axis: 'step';
+    included: boolean;
+    total_points: number;
+    returned_points: number;
+    downsampled: boolean;
+    sampling: 'none' | 'uniform';
+}
+export interface TrainingMetricsOptions {
+    view?: 'full' | 'series' | 'summary';
+    maxPoints?: number;
+}
+export interface TrainingMetricsRunContext {
+    status: string;
+    training_method?: string | null;
+    rlhf_type?: string | null;
+    train_type: string;
+    model_id: string;
+    model_revision: string;
+    current_step: number;
+    total_steps: number;
+    gpu_type: string;
+    gpu_count: number;
+    parameters: Record<string, unknown>;
+    omitted_parameter_keys: string[];
+}
 /** Training metrics for a job. */
 export interface TrainingMetrics {
     metrics: MetricPoint[];
     training_method?: string | null;
     rlhf_type?: string | null;
     graph_configs: MetricGraphConfig[];
+    metric_summaries?: TrainingMetricSummary[];
     resource_metrics?: TrainingResourceMetrics | null;
+    resource_summary?: TrainingResourceSummary | null;
+    series_meta?: TrainingSeriesMeta;
+    run_context?: TrainingMetricsRunContext;
     /** @deprecated Use metrics. Populated as a compatibility alias. */
     steps?: MetricPoint[];
 }
@@ -852,6 +947,8 @@ export interface MetricGraphConfig {
     key: string;
     label: string;
     color: string;
+    unit?: string;
+    goal?: string;
 }
 /** A training checkpoint. */
 export interface TrainingCheckpoint {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "runbios-sdk",
-  "version": "0.2.6",
+  "version": "0.2.7-dev.205",
   "description": "Official TypeScript SDK for the Run BiOS training and deployment platform API",
   "type": "module",
   "main": "./dist/index.js",