runbios-sdk 0.3.0-dev.329 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/resources/inference.js +1 -1
- package/dist/resources/loop.d.ts +1 -2
- package/dist/resources/loop.js +1 -2
- package/dist/types.d.ts +8 -58
- package/package.json +1 -1
package/dist/client.js
CHANGED
|
@@ -378,7 +378,7 @@ export class HttpClient {
|
|
|
378
378
|
constructor(config) {
|
|
379
379
|
// Default host stays api.runbios.ai for now; cutover to api.runbios.ai is
|
|
380
380
|
// planned once its DNS exists.
|
|
381
|
-
this.baseUrl = (config.baseUrl || envBaseUrl() || 'https://api
|
|
381
|
+
this.baseUrl = (config.baseUrl || envBaseUrl() || 'https://api.runbios.ai').replace(/\/+$/, '');
|
|
382
382
|
this.apiKey = config.apiKey ?? envApiKey();
|
|
383
383
|
this.accessToken = config.accessToken;
|
|
384
384
|
this.orgId = config.orgId;
|
package/dist/index.d.ts
CHANGED
|
@@ -36,7 +36,7 @@ import { Loop } from './resources/loop.js';
|
|
|
36
36
|
* SDK version. Sent as part of the User-Agent header.
|
|
37
37
|
* Must match package.json "version" -- enforced by a contract test.
|
|
38
38
|
*/
|
|
39
|
-
export declare const VERSION = "0.3.0
|
|
39
|
+
export declare const VERSION = "0.3.0";
|
|
40
40
|
export declare class RunBiOS {
|
|
41
41
|
/** Search models, fetch configs, check adapter compatibility. */
|
|
42
42
|
readonly models: Models;
|
package/dist/index.js
CHANGED
|
@@ -36,7 +36,7 @@ import { Loop } from './resources/loop.js';
|
|
|
36
36
|
* SDK version. Sent as part of the User-Agent header.
|
|
37
37
|
* Must match package.json "version" -- enforced by a contract test.
|
|
38
38
|
*/
|
|
39
|
-
export const VERSION = '0.3.0
|
|
39
|
+
export const VERSION = '0.3.0';
|
|
40
40
|
export class RunBiOS {
|
|
41
41
|
/** Search models, fetch configs, check adapter compatibility. */
|
|
42
42
|
models;
|
|
@@ -373,7 +373,7 @@ export class Inference {
|
|
|
373
373
|
this.key = config.inferenceKey || envInferenceKey() || envApiKey();
|
|
374
374
|
// Same default host as HttpClient (api.runbios.ai); api.runbios.ai cutover
|
|
375
375
|
// is planned once its DNS exists — update both call sites together.
|
|
376
|
-
this.baseUrl = (config.baseUrl || envBaseUrl() || 'https://api
|
|
376
|
+
this.baseUrl = (config.baseUrl || envBaseUrl() || 'https://api.runbios.ai').replace(/\/+$/, '');
|
|
377
377
|
this.timeout = config.timeout ?? 900_000;
|
|
378
378
|
this._http = http;
|
|
379
379
|
}
|
package/dist/resources/loop.d.ts
CHANGED
|
@@ -382,8 +382,7 @@ export declare class Loop {
|
|
|
382
382
|
* it made, winner or not, each the shape `attempts` has on the pipeline
|
|
383
383
|
* (with its `explanation` in plain words). `limit` is 50 when absent and at
|
|
384
384
|
* most 200. Narrow by `result` (`became_version`, `not_better`,
|
|
385
|
-
* `inconclusive`
|
|
386
|
-
* before it was tested --, `failed`, `stopped`, `running` -- which includes one
|
|
385
|
+
* `inconclusive`, `failed`, `stopped`, `running` -- which includes one
|
|
387
386
|
* waiting for a decision -- or `waiting_for_review`) and by `model` (`main`,
|
|
388
387
|
* or `second` for the second model's attempts); `total` follows the
|
|
389
388
|
* filters.
|
package/dist/resources/loop.js
CHANGED
|
@@ -633,8 +633,7 @@ export class Loop {
|
|
|
633
633
|
* it made, winner or not, each the shape `attempts` has on the pipeline
|
|
634
634
|
* (with its `explanation` in plain words). `limit` is 50 when absent and at
|
|
635
635
|
* most 200. Narrow by `result` (`became_version`, `not_better`,
|
|
636
|
-
* `inconclusive`
|
|
637
|
-
* before it was tested --, `failed`, `stopped`, `running` -- which includes one
|
|
636
|
+
* `inconclusive`, `failed`, `stopped`, `running` -- which includes one
|
|
638
637
|
* waiting for a decision -- or `waiting_for_review`) and by `model` (`main`,
|
|
639
638
|
* or `second` for the second model's attempts); `total` follows the
|
|
640
639
|
* filters.
|
package/dist/types.d.ts
CHANGED
|
@@ -8,13 +8,13 @@ export interface BiOSConfig {
|
|
|
8
8
|
orgId?: string;
|
|
9
9
|
/** Workspace ID. Optional when using API keys (resolved from the key). Can override for multi-workspace keys. */
|
|
10
10
|
workspaceId?: string;
|
|
11
|
-
/** Base URL for the API. Falls back to the RUNBIOS_BASE_URL environment variable (legacy: BIOS_BASE_URL), then the canonical https://api
|
|
11
|
+
/** 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. */
|
|
12
12
|
baseUrl?: string;
|
|
13
13
|
/** Request timeout in milliseconds. Defaults to 30000. */
|
|
14
14
|
timeout?: number;
|
|
15
15
|
/** Default per-deployment inference key. Can be overridden per inference call. */
|
|
16
16
|
inferenceKey?: string;
|
|
17
|
-
/** Inference base URL. Defaults to baseUrl, then https://api
|
|
17
|
+
/** Inference base URL. Defaults to baseUrl, then https://api.runbios.ai. */
|
|
18
18
|
inferenceBaseUrl?: string;
|
|
19
19
|
/** End-to-end inference timeout in milliseconds. Defaults to 15 minutes. */
|
|
20
20
|
inferenceTimeout?: number;
|
|
@@ -2967,22 +2967,9 @@ export interface LoopMetricPoint {
|
|
|
2967
2967
|
judge_candidate_mean: number | null;
|
|
2968
2968
|
/** The trainer's loss on its validation slice, as {@link Evaluation.trainer_eval_loss}. */
|
|
2969
2969
|
trainer_eval_loss: number | null;
|
|
2970
|
-
/**
|
|
2971
|
-
* The pipeline's margin frozen with this attempt's report: the most the
|
|
2972
|
-
* mean-change bar asks. The bar it actually had to clear is
|
|
2973
|
-
* {@link LoopMetricPoint.mean_change_needed}.
|
|
2974
|
-
*/
|
|
2970
|
+
/** The bar this attempt had to clear, frozen with its report. */
|
|
2975
2971
|
promote_margin: number | null;
|
|
2976
2972
|
promote_min_win_rate: number | null;
|
|
2977
|
-
/**
|
|
2978
|
-
* The average score change this attempt had to clear, frozen with its
|
|
2979
|
-
* report: `promote_margin`, lowered toward a quarter of the room left above
|
|
2980
|
-
* what it was compared with near the top, never below what the comparison
|
|
2981
|
-
* can tell from noise ({@link EvaluationMargin.mean_change_needed}). On a
|
|
2982
|
-
* report written before that bar existed, or one that compared nothing, it
|
|
2983
|
-
* is `promote_margin`. Null when the attempt has no report.
|
|
2984
|
-
*/
|
|
2985
|
-
mean_change_needed: number | null;
|
|
2986
2973
|
checkpoint_id: string | null;
|
|
2987
2974
|
checkpoint_step: number | null;
|
|
2988
2975
|
attempt_no: number | null;
|
|
@@ -3329,15 +3316,6 @@ export interface TrainingRun {
|
|
|
3329
3316
|
* cap when no placement price was reported).
|
|
3330
3317
|
*/
|
|
3331
3318
|
billed_candidate_up_to: boolean;
|
|
3332
|
-
/**
|
|
3333
|
-
* What was taken off for comparison machines that never started (never
|
|
3334
|
-
* reached running): the platform charged nothing for them, so neither does
|
|
3335
|
-
* the attempt -- say "Comparison machine: not charged (it never started)",
|
|
3336
|
-
* or, while a comparison machine that ran is still charged beside it, that
|
|
3337
|
-
* the one that never started was not charged. 0 when none; the cost figures
|
|
3338
|
-
* beside it are already net of it.
|
|
3339
|
-
*/
|
|
3340
|
-
comparison_returned_cents: number;
|
|
3341
3319
|
spent_eval_cents: number;
|
|
3342
3320
|
train_rows: number | null;
|
|
3343
3321
|
holdout_rows: number | null;
|
|
@@ -3459,8 +3437,6 @@ export interface TrainingRunSummary {
|
|
|
3459
3437
|
billed_candidate_cents: number;
|
|
3460
3438
|
/** See {@link TrainingRun.billed_candidate_up_to}. */
|
|
3461
3439
|
billed_candidate_up_to: boolean;
|
|
3462
|
-
/** See {@link TrainingRun.comparison_returned_cents}. */
|
|
3463
|
-
comparison_returned_cents: number;
|
|
3464
3440
|
spent_eval_cents: number;
|
|
3465
3441
|
/** The fourth money column. A row that leaves it out adds up short. */
|
|
3466
3442
|
benchmark_spent_cents: number;
|
|
@@ -3529,14 +3505,6 @@ export interface EvaluationMargin {
|
|
|
3529
3505
|
promote_margin: number;
|
|
3530
3506
|
promote_min_win_rate: number;
|
|
3531
3507
|
min_holdout_rows: number;
|
|
3532
|
-
/**
|
|
3533
|
-
* The average score change this comparison actually asked of the new model:
|
|
3534
|
-
* `promote_margin`, lowered toward a quarter of the room left above what it
|
|
3535
|
-
* was compared with once that is smaller, never below what the
|
|
3536
|
-
* comparison's size can tell from noise. Null when nothing was compared,
|
|
3537
|
-
* and on a report written before, whose bar was `promote_margin`.
|
|
3538
|
-
*/
|
|
3539
|
-
mean_change_needed: number | null;
|
|
3540
3508
|
}
|
|
3541
3509
|
/** The comparison report: the candidate against what serves today, same rows. */
|
|
3542
3510
|
export interface Evaluation {
|
|
@@ -4212,11 +4180,8 @@ export interface TrainingRuleMonthlyLimitRefusal {
|
|
|
4212
4180
|
/**
|
|
4213
4181
|
* The first instant of the next UTC month, when the month's count starts
|
|
4214
4182
|
* again from nothing. When one attempt alone can cost more than the whole
|
|
4215
|
-
* limit, no month will ever fit
|
|
4216
|
-
*
|
|
4217
|
-
* or -- when its next attempt is planned to need more training time than
|
|
4218
|
-
* the whole limit allows -- a smaller model does, and a save plans the
|
|
4219
|
-
* attempt again; `message` says which.
|
|
4183
|
+
* limit, no month will ever fit: saving the pipeline sets the limit again
|
|
4184
|
+
* from its model's prices, and nothing else changes it; `message` says which.
|
|
4220
4185
|
*/
|
|
4221
4186
|
resumes_at: string;
|
|
4222
4187
|
}
|
|
@@ -4259,8 +4224,6 @@ export interface PipelineActiveRun {
|
|
|
4259
4224
|
* the most it can have cost, so show it as "up to".
|
|
4260
4225
|
*/
|
|
4261
4226
|
cost_up_to: boolean;
|
|
4262
|
-
/** See {@link TrainingRun.comparison_returned_cents}. */
|
|
4263
|
-
comparison_returned_cents: number;
|
|
4264
4227
|
/** The version number it will take if it is put live. */
|
|
4265
4228
|
will_be_version: number;
|
|
4266
4229
|
/** Always null: nothing in flight is a version yet. */
|
|
@@ -4378,12 +4341,8 @@ export interface PipelineVersion {
|
|
|
4378
4341
|
* learned from (`rebuild`).
|
|
4379
4342
|
*/
|
|
4380
4343
|
export type PipelineAttemptTrigger = 'data' | 'schedule' | 'manual' | 'challenger' | 'rebuild';
|
|
4381
|
-
/**
|
|
4382
|
-
|
|
4383
|
-
* could not decide; `not_tested` is an attempt that ended before it was tested
|
|
4384
|
-
* (its comparison machine never started, or it expired first).
|
|
4385
|
-
*/
|
|
4386
|
-
export type PipelineAttemptOutcome = 'became_version' | 'not_better' | 'inconclusive' | 'not_tested' | 'stopped' | 'failed' | 'running' | 'waiting_for_review';
|
|
4344
|
+
/** What became of an attempt. */
|
|
4345
|
+
export type PipelineAttemptOutcome = 'became_version' | 'not_better' | 'inconclusive' | 'stopped' | 'failed' | 'running' | 'waiting_for_review';
|
|
4387
4346
|
/** One attempt: every training run a pipeline makes, winner or not. */
|
|
4388
4347
|
export interface PipelineAttempt {
|
|
4389
4348
|
attempt: number;
|
|
@@ -4412,8 +4371,6 @@ export interface PipelineAttempt {
|
|
|
4412
4371
|
cost_cents: number;
|
|
4413
4372
|
/** See {@link PipelineVersion.cost_up_to}. */
|
|
4414
4373
|
cost_up_to: boolean;
|
|
4415
|
-
/** See {@link TrainingRun.comparison_returned_cents}. */
|
|
4416
|
-
comparison_returned_cents: number;
|
|
4417
4374
|
verdict: TrainingVerdict | null;
|
|
4418
4375
|
win_rate: number | null;
|
|
4419
4376
|
/**
|
|
@@ -4830,13 +4787,6 @@ export interface TrainingRunCost {
|
|
|
4830
4787
|
benchmark_cents: number;
|
|
4831
4788
|
total_cents: number;
|
|
4832
4789
|
up_to: boolean;
|
|
4833
|
-
/**
|
|
4834
|
-
* What was taken off `comparison_cents` for comparison machines that never
|
|
4835
|
-
* started: "Comparison machine: not charged (it never started)" (with
|
|
4836
|
-
* `comparison_cents` above 0, only the one that never started). 0 when
|
|
4837
|
-
* none.
|
|
4838
|
-
*/
|
|
4839
|
-
comparison_returned_cents: number;
|
|
4840
4790
|
}
|
|
4841
4791
|
export interface TrainingRunActionResponse {
|
|
4842
4792
|
run: TrainingRun;
|
|
@@ -4907,7 +4857,7 @@ export interface PipelineResponse {
|
|
|
4907
4857
|
pipeline: Pipeline;
|
|
4908
4858
|
}
|
|
4909
4859
|
/** What became of an attempt, as `listPipelineAttempts` filters it. */
|
|
4910
|
-
export type PipelineAttemptResultFilter = 'became_version' | 'not_better' | 'inconclusive' | '
|
|
4860
|
+
export type PipelineAttemptResultFilter = 'became_version' | 'not_better' | 'inconclusive' | 'failed' | 'stopped' | 'running' | 'waiting_for_review';
|
|
4911
4861
|
/** Which model's attempts: the pipeline's own (`main`) or its second model's (`second`). */
|
|
4912
4862
|
export type PipelineAttemptModelFilter = 'main' | 'second';
|
|
4913
4863
|
export interface PipelineAttemptListParams {
|