runbios-sdk 0.3.0-rc.325 → 0.3.0-rc.330
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/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/dist/resources/loop.d.ts +2 -1
- package/dist/resources/loop.js +2 -1
- package/dist/types.d.ts +56 -6
- package/package.json +1 -1
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-rc.
|
|
39
|
+
export declare const VERSION = "0.3.0-rc.330";
|
|
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-rc.
|
|
39
|
+
export const VERSION = '0.3.0-rc.330';
|
|
40
40
|
export class RunBiOS {
|
|
41
41
|
/** Search models, fetch configs, check adapter compatibility. */
|
|
42
42
|
models;
|
package/dist/resources/loop.d.ts
CHANGED
|
@@ -382,7 +382,8 @@ 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
|
|
385
|
+
* `inconclusive` -- tested, could not decide --, `not_tested` -- ended
|
|
386
|
+
* before it was tested --, `failed`, `stopped`, `running` -- which includes one
|
|
386
387
|
* waiting for a decision -- or `waiting_for_review`) and by `model` (`main`,
|
|
387
388
|
* or `second` for the second model's attempts); `total` follows the
|
|
388
389
|
* filters.
|
package/dist/resources/loop.js
CHANGED
|
@@ -633,7 +633,8 @@ 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
|
|
636
|
+
* `inconclusive` -- tested, could not decide --, `not_tested` -- ended
|
|
637
|
+
* before it was tested --, `failed`, `stopped`, `running` -- which includes one
|
|
637
638
|
* waiting for a decision -- or `waiting_for_review`) and by `model` (`main`,
|
|
638
639
|
* or `second` for the second model's attempts); `total` follows the
|
|
639
640
|
* filters.
|
package/dist/types.d.ts
CHANGED
|
@@ -2967,9 +2967,22 @@ 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
|
-
/**
|
|
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
|
+
*/
|
|
2971
2975
|
promote_margin: number | null;
|
|
2972
2976
|
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;
|
|
2973
2986
|
checkpoint_id: string | null;
|
|
2974
2987
|
checkpoint_step: number | null;
|
|
2975
2988
|
attempt_no: number | null;
|
|
@@ -3316,6 +3329,15 @@ export interface TrainingRun {
|
|
|
3316
3329
|
* cap when no placement price was reported).
|
|
3317
3330
|
*/
|
|
3318
3331
|
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;
|
|
3319
3341
|
spent_eval_cents: number;
|
|
3320
3342
|
train_rows: number | null;
|
|
3321
3343
|
holdout_rows: number | null;
|
|
@@ -3437,6 +3459,8 @@ export interface TrainingRunSummary {
|
|
|
3437
3459
|
billed_candidate_cents: number;
|
|
3438
3460
|
/** See {@link TrainingRun.billed_candidate_up_to}. */
|
|
3439
3461
|
billed_candidate_up_to: boolean;
|
|
3462
|
+
/** See {@link TrainingRun.comparison_returned_cents}. */
|
|
3463
|
+
comparison_returned_cents: number;
|
|
3440
3464
|
spent_eval_cents: number;
|
|
3441
3465
|
/** The fourth money column. A row that leaves it out adds up short. */
|
|
3442
3466
|
benchmark_spent_cents: number;
|
|
@@ -3505,6 +3529,14 @@ export interface EvaluationMargin {
|
|
|
3505
3529
|
promote_margin: number;
|
|
3506
3530
|
promote_min_win_rate: number;
|
|
3507
3531
|
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;
|
|
3508
3540
|
}
|
|
3509
3541
|
/** The comparison report: the candidate against what serves today, same rows. */
|
|
3510
3542
|
export interface Evaluation {
|
|
@@ -4180,8 +4212,11 @@ export interface TrainingRuleMonthlyLimitRefusal {
|
|
|
4180
4212
|
/**
|
|
4181
4213
|
* The first instant of the next UTC month, when the month's count starts
|
|
4182
4214
|
* again from nothing. When one attempt alone can cost more than the whole
|
|
4183
|
-
* limit, no month will ever fit
|
|
4184
|
-
*
|
|
4215
|
+
* limit, no month will ever fit, and this is not a day the pipeline trains
|
|
4216
|
+
* again: saving the pipeline sets the limit again from its model's prices,
|
|
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.
|
|
4185
4220
|
*/
|
|
4186
4221
|
resumes_at: string;
|
|
4187
4222
|
}
|
|
@@ -4224,6 +4259,8 @@ export interface PipelineActiveRun {
|
|
|
4224
4259
|
* the most it can have cost, so show it as "up to".
|
|
4225
4260
|
*/
|
|
4226
4261
|
cost_up_to: boolean;
|
|
4262
|
+
/** See {@link TrainingRun.comparison_returned_cents}. */
|
|
4263
|
+
comparison_returned_cents: number;
|
|
4227
4264
|
/** The version number it will take if it is put live. */
|
|
4228
4265
|
will_be_version: number;
|
|
4229
4266
|
/** Always null: nothing in flight is a version yet. */
|
|
@@ -4341,8 +4378,12 @@ export interface PipelineVersion {
|
|
|
4341
4378
|
* learned from (`rebuild`).
|
|
4342
4379
|
*/
|
|
4343
4380
|
export type PipelineAttemptTrigger = 'data' | 'schedule' | 'manual' | 'challenger' | 'rebuild';
|
|
4344
|
-
/**
|
|
4345
|
-
|
|
4381
|
+
/**
|
|
4382
|
+
* What became of an attempt. `inconclusive` is a held-back test that ran and
|
|
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';
|
|
4346
4387
|
/** One attempt: every training run a pipeline makes, winner or not. */
|
|
4347
4388
|
export interface PipelineAttempt {
|
|
4348
4389
|
attempt: number;
|
|
@@ -4371,6 +4412,8 @@ export interface PipelineAttempt {
|
|
|
4371
4412
|
cost_cents: number;
|
|
4372
4413
|
/** See {@link PipelineVersion.cost_up_to}. */
|
|
4373
4414
|
cost_up_to: boolean;
|
|
4415
|
+
/** See {@link TrainingRun.comparison_returned_cents}. */
|
|
4416
|
+
comparison_returned_cents: number;
|
|
4374
4417
|
verdict: TrainingVerdict | null;
|
|
4375
4418
|
win_rate: number | null;
|
|
4376
4419
|
/**
|
|
@@ -4787,6 +4830,13 @@ export interface TrainingRunCost {
|
|
|
4787
4830
|
benchmark_cents: number;
|
|
4788
4831
|
total_cents: number;
|
|
4789
4832
|
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;
|
|
4790
4840
|
}
|
|
4791
4841
|
export interface TrainingRunActionResponse {
|
|
4792
4842
|
run: TrainingRun;
|
|
@@ -4857,7 +4907,7 @@ export interface PipelineResponse {
|
|
|
4857
4907
|
pipeline: Pipeline;
|
|
4858
4908
|
}
|
|
4859
4909
|
/** What became of an attempt, as `listPipelineAttempts` filters it. */
|
|
4860
|
-
export type PipelineAttemptResultFilter = 'became_version' | 'not_better' | 'inconclusive' | 'failed' | 'stopped' | 'running' | 'waiting_for_review';
|
|
4910
|
+
export type PipelineAttemptResultFilter = 'became_version' | 'not_better' | 'inconclusive' | 'not_tested' | 'failed' | 'stopped' | 'running' | 'waiting_for_review';
|
|
4861
4911
|
/** Which model's attempts: the pipeline's own (`main`) or its second model's (`second`). */
|
|
4862
4912
|
export type PipelineAttemptModelFilter = 'main' | 'second';
|
|
4863
4913
|
export interface PipelineAttemptListParams {
|