runbios-sdk 0.3.0-dev.327 → 0.3.0-dev.329

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 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-dev.327";
39
+ export declare const VERSION = "0.3.0-dev.329";
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-dev.327';
39
+ export const VERSION = '0.3.0-dev.329';
40
40
  export class RunBiOS {
41
41
  /** Search models, fetch configs, check adapter compatibility. */
42
42
  models;
@@ -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`, `failed`, `stopped`, `running` -- which includes one
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.
@@ -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`, `failed`, `stopped`, `running` -- which includes one
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
- /** The bar this attempt had to clear, frozen with its report. */
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;
@@ -3516,6 +3529,14 @@ export interface EvaluationMargin {
3516
3529
  promote_margin: number;
3517
3530
  promote_min_win_rate: number;
3518
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;
3519
3540
  }
3520
3541
  /** The comparison report: the candidate against what serves today, same rows. */
3521
3542
  export interface Evaluation {
@@ -4357,8 +4378,12 @@ export interface PipelineVersion {
4357
4378
  * learned from (`rebuild`).
4358
4379
  */
4359
4380
  export type PipelineAttemptTrigger = 'data' | 'schedule' | 'manual' | 'challenger' | 'rebuild';
4360
- /** What became of an attempt. */
4361
- export type PipelineAttemptOutcome = 'became_version' | 'not_better' | 'inconclusive' | 'stopped' | 'failed' | 'running' | 'waiting_for_review';
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';
4362
4387
  /** One attempt: every training run a pipeline makes, winner or not. */
4363
4388
  export interface PipelineAttempt {
4364
4389
  attempt: number;
@@ -4882,7 +4907,7 @@ export interface PipelineResponse {
4882
4907
  pipeline: Pipeline;
4883
4908
  }
4884
4909
  /** What became of an attempt, as `listPipelineAttempts` filters it. */
4885
- 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';
4886
4911
  /** Which model's attempts: the pipeline's own (`main`) or its second model's (`second`). */
4887
4912
  export type PipelineAttemptModelFilter = 'main' | 'second';
4888
4913
  export interface PipelineAttemptListParams {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "runbios-sdk",
3
- "version": "0.3.0-dev.327",
3
+ "version": "0.3.0-dev.329",
4
4
  "description": "Official TypeScript SDK for the Run BiOS training and deployment platform API",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",