shap-svg 0.2.1 → 0.2.2

package/dist/index.d.cts

@@ -1,5 +1,5 @@
-import { P as ParsedExplanation, D as DisplayRows, V as ValuePrecision, R as RowSort } from './format-wEav_cPe.cjs';
-export { a as DisplayRow, E as Explanation, I as InvalidExplanationError, U as UnsupportedContractVersionError, f as formatFeatureLabel, b as formatLevel, c as formatShapValue, s as sortDisplayRows } from './format-wEav_cPe.cjs';
+import { P as ParsedExplanation, a as PlotLabels, D as DisplayRows, V as ValuePrecision, R as RowSort } from './labels-7wofev8M.cjs';
+export { b as DisplayRow, E as Explanation, I as InvalidExplanationError, U as UnsupportedContractVersionError, f as formatFeatureLabel, c as formatLevel, d as formatShapValue, r as resolveLabels, s as shapLabels, e as sortDisplayRows } from './labels-7wofev8M.cjs';
 
 /**
  * Taxonomy-aware views of an Explanation.
@@ -68,7 +68,7 @@ declare function orderFeatures(importance: number[]): number[];
  * absorbs the Feature ranked `maxDisplay` — so maxDisplay=15 shows 14 real Features. The default
  * corrected mode shows `maxDisplay` real Features and adds the Other features row alongside.
  */
-declare function collapseToDisplay(featureNames: string[], importance: number[], order: number[], maxDisplay: number, faithfulOtherRow: boolean): DisplayRows;
+declare function collapseToDisplay(featureNames: string[], importance: number[], order: number[], maxDisplay: number, faithfulOtherRow: boolean, labels?: PlotLabels): DisplayRows;
 
 type AxisTick = {
     value: number;
@@ -95,6 +95,8 @@ type BarLayoutOptions = {
     marginLeft: number;
     marginRight: number;
     marginTop: number;
+    /** Resolved wording; SHAP's when omitted. */
+    labels?: PlotLabels;
 };
 type BarGeometry = {
     label: string;
@@ -170,6 +172,8 @@ type WaterfallLayoutOptions = {
     marginTop: number;
     /** Decimal places for the bar labels. Display only; omit for 3 significant figures. */
     decimals?: ValuePrecision;
+    /** Resolved wording; SHAP's when omitted. */
+    labels?: PlotLabels;
 };
 type Point = {
     x: number;
@@ -245,7 +249,7 @@ type WaterfallLayout = {
  * The value-space part of shap/plots/_waterfall.py::waterfall_legacy.
  * It walks backward from f(x), leaving pixel scaling and arrowheads to waterfallLayout.
  */
-declare function waterfallRows(explanation: ParsedExplanation, sampleIndex: number, maxDisplay: number, faithfulOtherRow: boolean): WaterfallRows;
+declare function waterfallRows(explanation: ParsedExplanation, sampleIndex: number, maxDisplay: number, faithfulOtherRow: boolean, labels?: PlotLabels): WaterfallRows;
 declare function waterfallLayout(valueRows: WaterfallRows, opts: WaterfallLayoutOptions): WaterfallLayout;
 
 type ColormapName = "red_blue" | "red_white_blue";
@@ -371,6 +375,8 @@ type BeeswarmLayoutOptions = {
     dotRadius: number;
     /** Draw SHAP's feature value colour bar right of the plot. */
     colorBar?: boolean;
+    /** Resolved wording; SHAP's when omitted. */
+    labels?: PlotLabels;
 };
 type BeeswarmPointGeometry = Omit<BeeswarmPoint, "x" | "y"> & {
     x: number;
@@ -401,7 +407,7 @@ type BeeswarmLayout = {
  * Computes SHAP-compatible beeswarm rows entirely in value space. Pixel scaling belongs in
  * beeswarmLayout so golden values can be compared without a viewport.
  */
-declare function beeswarmRows(explanation: ParsedExplanation, maxDisplay: number, faithfulOtherRow: boolean, seed?: number, rowSort?: RowSort): BeeswarmRows;
+declare function beeswarmRows(explanation: ParsedExplanation, maxDisplay: number, faithfulOtherRow: boolean, seed?: number, rowSort?: RowSort, labels?: PlotLabels): BeeswarmRows;
 /** Projects beeswarm value-space rows into SVG coordinates. */
 declare function beeswarmLayout(valueRows: BeeswarmRows, opts: BeeswarmLayoutOptions): BeeswarmLayout;
 
@@ -454,6 +460,8 @@ type HeatmapLayoutOptions = {
     marginTop: number;
     /** Draw SHAP's SHAP value colour bar right of the side bars. */
     colorBar?: boolean;
+    /** Resolved wording; SHAP's when omitted. */
+    labels?: PlotLabels;
 };
 type HeatmapCellGeometry = HeatmapCell & {
     x: number;
@@ -538,8 +546,8 @@ type HeatmapLayout = {
     height: number;
 };
 /** Computes the SHAP-compatible orderings, collapse, colours, line, and side bars in value space. */
-declare function heatmapRows(explanation: ParsedExplanation, maxDisplay: number, faithfulOtherRow: boolean, rowSort?: RowSort): HeatmapRows;
+declare function heatmapRows(explanation: ParsedExplanation, maxDisplay: number, faithfulOtherRow: boolean, rowSort?: RowSort, labels?: PlotLabels): HeatmapRows;
 /** Projects heatmap value-space rows into SVG geometry. */
 declare function heatmapLayout(valueRows: HeatmapRows, opts: HeatmapLayoutOptions): HeatmapLayout;
 
-export { type AggregatedExplanation, BEESWARM_MISSING_COLOR, BEESWARM_ROW_HEIGHT, type BarGeometry, type BarLayout, type BarLayoutOptions, type BeeswarmLayout, type BeeswarmLayoutOptions, type BeeswarmPoint, type BeeswarmPointGeometry, type BeeswarmRow, type BeeswarmRowGeometry, type BeeswarmRows, type ColorBarGeometry, type ColorBarSpec, type ColorBarStep, type ColorBarTick, type ColormapName, DisplayRows, type GenusGrouping, type HeatmapAxisMark, type HeatmapCell, type HeatmapCellGeometry, type HeatmapColumn, type HeatmapColumnGeometry, type HeatmapLayout, type HeatmapLayoutOptions, type HeatmapLinePoint, type HeatmapRow, type HeatmapRowGeometry, type HeatmapRows, type HeatmapSideBarGeometry, type HeatmapSpine, type HeatmapYTick, NEGATIVE_COLOR, POSITIVE_COLOR, ParsedExplanation, type Point, RowSort, ValuePrecision, WATERFALL_BASE_LABEL_DY, WATERFALL_HEAD_LENGTH_PX, WATERFALL_TICK_LABEL_DY, type WaterfallArrowGeometry, type WaterfallAxisMark, type WaterfallConnector, type WaterfallLayout, type WaterfallLayoutOptions, type WaterfallRow, type WaterfallRows, type WaterfallSeparator, type WaterfallTick, type WaterfallValueLabel, aggregateByGenus, barLayout, beeswarmLayout, beeswarmRows, collapseToDisplay, colorBarExtent, colorBarLayout, fitColorBar, genusOf, globalImportance, groupByGenus, groupExplanationByGenus, heatmapLayout, heatmapRows, orderFeatures, parseExplanation, sampleColormap, scalarFormatterLabels, waterfallLayout, waterfallRows };
+export { type AggregatedExplanation, BEESWARM_MISSING_COLOR, BEESWARM_ROW_HEIGHT, type BarGeometry, type BarLayout, type BarLayoutOptions, type BeeswarmLayout, type BeeswarmLayoutOptions, type BeeswarmPoint, type BeeswarmPointGeometry, type BeeswarmRow, type BeeswarmRowGeometry, type BeeswarmRows, type ColorBarGeometry, type ColorBarSpec, type ColorBarStep, type ColorBarTick, type ColormapName, DisplayRows, type GenusGrouping, type HeatmapAxisMark, type HeatmapCell, type HeatmapCellGeometry, type HeatmapColumn, type HeatmapColumnGeometry, type HeatmapLayout, type HeatmapLayoutOptions, type HeatmapLinePoint, type HeatmapRow, type HeatmapRowGeometry, type HeatmapRows, type HeatmapSideBarGeometry, type HeatmapSpine, type HeatmapYTick, NEGATIVE_COLOR, POSITIVE_COLOR, ParsedExplanation, PlotLabels, type Point, RowSort, ValuePrecision, WATERFALL_BASE_LABEL_DY, WATERFALL_HEAD_LENGTH_PX, WATERFALL_TICK_LABEL_DY, type WaterfallArrowGeometry, type WaterfallAxisMark, type WaterfallConnector, type WaterfallLayout, type WaterfallLayoutOptions, type WaterfallRow, type WaterfallRows, type WaterfallSeparator, type WaterfallTick, type WaterfallValueLabel, aggregateByGenus, barLayout, beeswarmLayout, beeswarmRows, collapseToDisplay, colorBarExtent, colorBarLayout, fitColorBar, genusOf, globalImportance, groupByGenus, groupExplanationByGenus, heatmapLayout, heatmapRows, orderFeatures, parseExplanation, sampleColormap, scalarFormatterLabels, waterfallLayout, waterfallRows };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import { P as ParsedExplanation, D as DisplayRows, V as ValuePrecision, R as RowSort } from './format-wEav_cPe.js';
-export { a as DisplayRow, E as Explanation, I as InvalidExplanationError, U as UnsupportedContractVersionError, f as formatFeatureLabel, b as formatLevel, c as formatShapValue, s as sortDisplayRows } from './format-wEav_cPe.js';
+import { P as ParsedExplanation, a as PlotLabels, D as DisplayRows, V as ValuePrecision, R as RowSort } from './labels-7wofev8M.js';
+export { b as DisplayRow, E as Explanation, I as InvalidExplanationError, U as UnsupportedContractVersionError, f as formatFeatureLabel, c as formatLevel, d as formatShapValue, r as resolveLabels, s as shapLabels, e as sortDisplayRows } from './labels-7wofev8M.js';
 
 /**
  * Taxonomy-aware views of an Explanation.
@@ -68,7 +68,7 @@ declare function orderFeatures(importance: number[]): number[];
  * absorbs the Feature ranked `maxDisplay` — so maxDisplay=15 shows 14 real Features. The default
  * corrected mode shows `maxDisplay` real Features and adds the Other features row alongside.
  */
-declare function collapseToDisplay(featureNames: string[], importance: number[], order: number[], maxDisplay: number, faithfulOtherRow: boolean): DisplayRows;
+declare function collapseToDisplay(featureNames: string[], importance: number[], order: number[], maxDisplay: number, faithfulOtherRow: boolean, labels?: PlotLabels): DisplayRows;
 
 type AxisTick = {
     value: number;
@@ -95,6 +95,8 @@ type BarLayoutOptions = {
     marginLeft: number;
     marginRight: number;
     marginTop: number;
+    /** Resolved wording; SHAP's when omitted. */
+    labels?: PlotLabels;
 };
 type BarGeometry = {
     label: string;
@@ -170,6 +172,8 @@ type WaterfallLayoutOptions = {
     marginTop: number;
     /** Decimal places for the bar labels. Display only; omit for 3 significant figures. */
     decimals?: ValuePrecision;
+    /** Resolved wording; SHAP's when omitted. */
+    labels?: PlotLabels;
 };
 type Point = {
     x: number;
@@ -245,7 +249,7 @@ type WaterfallLayout = {
  * The value-space part of shap/plots/_waterfall.py::waterfall_legacy.
  * It walks backward from f(x), leaving pixel scaling and arrowheads to waterfallLayout.
  */
-declare function waterfallRows(explanation: ParsedExplanation, sampleIndex: number, maxDisplay: number, faithfulOtherRow: boolean): WaterfallRows;
+declare function waterfallRows(explanation: ParsedExplanation, sampleIndex: number, maxDisplay: number, faithfulOtherRow: boolean, labels?: PlotLabels): WaterfallRows;
 declare function waterfallLayout(valueRows: WaterfallRows, opts: WaterfallLayoutOptions): WaterfallLayout;
 
 type ColormapName = "red_blue" | "red_white_blue";
@@ -371,6 +375,8 @@ type BeeswarmLayoutOptions = {
     dotRadius: number;
     /** Draw SHAP's feature value colour bar right of the plot. */
     colorBar?: boolean;
+    /** Resolved wording; SHAP's when omitted. */
+    labels?: PlotLabels;
 };
 type BeeswarmPointGeometry = Omit<BeeswarmPoint, "x" | "y"> & {
     x: number;
@@ -401,7 +407,7 @@ type BeeswarmLayout = {
  * Computes SHAP-compatible beeswarm rows entirely in value space. Pixel scaling belongs in
  * beeswarmLayout so golden values can be compared without a viewport.
  */
-declare function beeswarmRows(explanation: ParsedExplanation, maxDisplay: number, faithfulOtherRow: boolean, seed?: number, rowSort?: RowSort): BeeswarmRows;
+declare function beeswarmRows(explanation: ParsedExplanation, maxDisplay: number, faithfulOtherRow: boolean, seed?: number, rowSort?: RowSort, labels?: PlotLabels): BeeswarmRows;
 /** Projects beeswarm value-space rows into SVG coordinates. */
 declare function beeswarmLayout(valueRows: BeeswarmRows, opts: BeeswarmLayoutOptions): BeeswarmLayout;
 
@@ -454,6 +460,8 @@ type HeatmapLayoutOptions = {
     marginTop: number;
     /** Draw SHAP's SHAP value colour bar right of the side bars. */
     colorBar?: boolean;
+    /** Resolved wording; SHAP's when omitted. */
+    labels?: PlotLabels;
 };
 type HeatmapCellGeometry = HeatmapCell & {
     x: number;
@@ -538,8 +546,8 @@ type HeatmapLayout = {
     height: number;
 };
 /** Computes the SHAP-compatible orderings, collapse, colours, line, and side bars in value space. */
-declare function heatmapRows(explanation: ParsedExplanation, maxDisplay: number, faithfulOtherRow: boolean, rowSort?: RowSort): HeatmapRows;
+declare function heatmapRows(explanation: ParsedExplanation, maxDisplay: number, faithfulOtherRow: boolean, rowSort?: RowSort, labels?: PlotLabels): HeatmapRows;
 /** Projects heatmap value-space rows into SVG geometry. */
 declare function heatmapLayout(valueRows: HeatmapRows, opts: HeatmapLayoutOptions): HeatmapLayout;
 
-export { type AggregatedExplanation, BEESWARM_MISSING_COLOR, BEESWARM_ROW_HEIGHT, type BarGeometry, type BarLayout, type BarLayoutOptions, type BeeswarmLayout, type BeeswarmLayoutOptions, type BeeswarmPoint, type BeeswarmPointGeometry, type BeeswarmRow, type BeeswarmRowGeometry, type BeeswarmRows, type ColorBarGeometry, type ColorBarSpec, type ColorBarStep, type ColorBarTick, type ColormapName, DisplayRows, type GenusGrouping, type HeatmapAxisMark, type HeatmapCell, type HeatmapCellGeometry, type HeatmapColumn, type HeatmapColumnGeometry, type HeatmapLayout, type HeatmapLayoutOptions, type HeatmapLinePoint, type HeatmapRow, type HeatmapRowGeometry, type HeatmapRows, type HeatmapSideBarGeometry, type HeatmapSpine, type HeatmapYTick, NEGATIVE_COLOR, POSITIVE_COLOR, ParsedExplanation, type Point, RowSort, ValuePrecision, WATERFALL_BASE_LABEL_DY, WATERFALL_HEAD_LENGTH_PX, WATERFALL_TICK_LABEL_DY, type WaterfallArrowGeometry, type WaterfallAxisMark, type WaterfallConnector, type WaterfallLayout, type WaterfallLayoutOptions, type WaterfallRow, type WaterfallRows, type WaterfallSeparator, type WaterfallTick, type WaterfallValueLabel, aggregateByGenus, barLayout, beeswarmLayout, beeswarmRows, collapseToDisplay, colorBarExtent, colorBarLayout, fitColorBar, genusOf, globalImportance, groupByGenus, groupExplanationByGenus, heatmapLayout, heatmapRows, orderFeatures, parseExplanation, sampleColormap, scalarFormatterLabels, waterfallLayout, waterfallRows };
+export { type AggregatedExplanation, BEESWARM_MISSING_COLOR, BEESWARM_ROW_HEIGHT, type BarGeometry, type BarLayout, type BarLayoutOptions, type BeeswarmLayout, type BeeswarmLayoutOptions, type BeeswarmPoint, type BeeswarmPointGeometry, type BeeswarmRow, type BeeswarmRowGeometry, type BeeswarmRows, type ColorBarGeometry, type ColorBarSpec, type ColorBarStep, type ColorBarTick, type ColormapName, DisplayRows, type GenusGrouping, type HeatmapAxisMark, type HeatmapCell, type HeatmapCellGeometry, type HeatmapColumn, type HeatmapColumnGeometry, type HeatmapLayout, type HeatmapLayoutOptions, type HeatmapLinePoint, type HeatmapRow, type HeatmapRowGeometry, type HeatmapRows, type HeatmapSideBarGeometry, type HeatmapSpine, type HeatmapYTick, NEGATIVE_COLOR, POSITIVE_COLOR, ParsedExplanation, PlotLabels, type Point, RowSort, ValuePrecision, WATERFALL_BASE_LABEL_DY, WATERFALL_HEAD_LENGTH_PX, WATERFALL_TICK_LABEL_DY, type WaterfallArrowGeometry, type WaterfallAxisMark, type WaterfallConnector, type WaterfallLayout, type WaterfallLayoutOptions, type WaterfallRow, type WaterfallRows, type WaterfallSeparator, type WaterfallTick, type WaterfallValueLabel, aggregateByGenus, barLayout, beeswarmLayout, beeswarmRows, collapseToDisplay, colorBarExtent, colorBarLayout, fitColorBar, genusOf, globalImportance, groupByGenus, groupExplanationByGenus, heatmapLayout, heatmapRows, orderFeatures, parseExplanation, sampleColormap, scalarFormatterLabels, waterfallLayout, waterfallRows };

package/dist/index.js

@@ -27,12 +27,14 @@ import {
   heatmapRows,
   orderFeatures,
   parseExplanation,
+  resolveLabels,
   sampleColormap,
   scalarFormatterLabels,
+  shapLabels,
   sortDisplayRows,
   waterfallLayout,
   waterfallRows
-} from "./chunk-ZWO4CN22.js";
+} from "./chunk-4X6PMJYT.js";
 export {
   BEESWARM_MISSING_COLOR,
   BEESWARM_ROW_HEIGHT,
@@ -62,8 +64,10 @@ export {
   heatmapRows,
   orderFeatures,
   parseExplanation,
+  resolveLabels,
   sampleColormap,
   scalarFormatterLabels,
+  shapLabels,
   sortDisplayRows,
   waterfallLayout,
   waterfallRows

package/dist/{format-wEav_cPe.d.cts → labels-7wofev8M.d.cts}

@@ -108,4 +108,47 @@ declare function formatLevel(v: number, decimals?: ValuePrecision): string;
 /** Spec 3.5 V3. The italic styling is applied by the renderer, not here. */
 declare function formatFeatureLabel(name: string): string;
 
-export { type DisplayRows as D, type Explanation as E, InvalidExplanationError as I, type ParsedExplanation as P, type RowSort as R, UnsupportedContractVersionError as U, type ValuePrecision as V, type DisplayRow as a, formatLevel as b, formatShapValue as c, formatFeatureLabel as f, sortDisplayRows as s };
+/**
+ * Every piece of text the charts draw, keyed by what it means rather than where
+ * it appears, so a word used in two places is changed once.
+ *
+ * The defaults are SHAP 0.49.1's own wording: a chart given no labels reads the
+ * way SHAP's figures do.
+ */
+type PlotLabels = {
+    /** The value itself, as the beeswarm tooltip names it. */
+    shapValue: string;
+    /** The axis that measures it: beeswarm x axis and heatmap colour bar (_labels.py VALUE). */
+    shapValueAxis: string;
+    /** The bar chart's x axis. */
+    meanAbsShapValue: string;
+    /** A Feature's input value: beeswarm tooltip and colour bar title. */
+    featureValue: string;
+    /** The low end of the beeswarm colour bar. */
+    featureValueLow: string;
+    /** The high end of the beeswarm colour bar. */
+    featureValueHigh: string;
+    /** Written in place of a Feature value the payload does not have. */
+    missingFeatureValue: string;
+    /** The heatmap's Sample axis. */
+    samples: string;
+    /** A Sample's summed SHAP values, in the heatmap tooltip. */
+    sampleTotal: string;
+    /** A Sample the payload gives no label, numbered from 1. */
+    sampleFallback: (sampleNumber: number) => string;
+    /** The waterfall's starting point, E[f(X)]. */
+    baseValue: string;
+    /** The waterfall's end point, f(x). */
+    modelOutput: string;
+    /**
+     * The row standing in for every Feature not shown. `style` is "sum" for the
+     * bar, beeswarm and heatmap row in faithfulOtherRow mode, which SHAP titles as
+     * a sum, and "count" everywhere else.
+     */
+    otherFeatures: (count: number, style: "sum" | "count") => string;
+};
+declare const shapLabels: PlotLabels;
+/** The given wording over SHAP's. A key given as undefined keeps the default. */
+declare function resolveLabels(labels?: Partial<PlotLabels>): PlotLabels;
+
+export { type DisplayRows as D, type Explanation as E, InvalidExplanationError as I, type ParsedExplanation as P, type RowSort as R, UnsupportedContractVersionError as U, type ValuePrecision as V, type PlotLabels as a, type DisplayRow as b, formatLevel as c, formatShapValue as d, sortDisplayRows as e, formatFeatureLabel as f, resolveLabels as r, shapLabels as s };

package/dist/{format-wEav_cPe.d.ts → labels-7wofev8M.d.ts}

@@ -108,4 +108,47 @@ declare function formatLevel(v: number, decimals?: ValuePrecision): string;
 /** Spec 3.5 V3. The italic styling is applied by the renderer, not here. */
 declare function formatFeatureLabel(name: string): string;
 
-export { type DisplayRows as D, type Explanation as E, InvalidExplanationError as I, type ParsedExplanation as P, type RowSort as R, UnsupportedContractVersionError as U, type ValuePrecision as V, type DisplayRow as a, formatLevel as b, formatShapValue as c, formatFeatureLabel as f, sortDisplayRows as s };
+/**
+ * Every piece of text the charts draw, keyed by what it means rather than where
+ * it appears, so a word used in two places is changed once.
+ *
+ * The defaults are SHAP 0.49.1's own wording: a chart given no labels reads the
+ * way SHAP's figures do.
+ */
+type PlotLabels = {
+    /** The value itself, as the beeswarm tooltip names it. */
+    shapValue: string;
+    /** The axis that measures it: beeswarm x axis and heatmap colour bar (_labels.py VALUE). */
+    shapValueAxis: string;
+    /** The bar chart's x axis. */
+    meanAbsShapValue: string;
+    /** A Feature's input value: beeswarm tooltip and colour bar title. */
+    featureValue: string;
+    /** The low end of the beeswarm colour bar. */
+    featureValueLow: string;
+    /** The high end of the beeswarm colour bar. */
+    featureValueHigh: string;
+    /** Written in place of a Feature value the payload does not have. */
+    missingFeatureValue: string;
+    /** The heatmap's Sample axis. */
+    samples: string;
+    /** A Sample's summed SHAP values, in the heatmap tooltip. */
+    sampleTotal: string;
+    /** A Sample the payload gives no label, numbered from 1. */
+    sampleFallback: (sampleNumber: number) => string;
+    /** The waterfall's starting point, E[f(X)]. */
+    baseValue: string;
+    /** The waterfall's end point, f(x). */
+    modelOutput: string;
+    /**
+     * The row standing in for every Feature not shown. `style` is "sum" for the
+     * bar, beeswarm and heatmap row in faithfulOtherRow mode, which SHAP titles as
+     * a sum, and "count" everywhere else.
+     */
+    otherFeatures: (count: number, style: "sum" | "count") => string;
+};
+declare const shapLabels: PlotLabels;
+/** The given wording over SHAP's. A key given as undefined keeps the default. */
+declare function resolveLabels(labels?: Partial<PlotLabels>): PlotLabels;
+
+export { type DisplayRows as D, type Explanation as E, InvalidExplanationError as I, type ParsedExplanation as P, type RowSort as R, UnsupportedContractVersionError as U, type ValuePrecision as V, type PlotLabels as a, type DisplayRow as b, formatLevel as c, formatShapValue as d, sortDisplayRows as e, formatFeatureLabel as f, resolveLabels as r, shapLabels as s };