From 8c6ac1174cd1020c00491736a3d0fa78e05e0eed Mon Sep 17 00:00:00 2001 From: Crystal Qian Date: Wed, 27 Jul 2022 11:28:23 -0700 Subject: [PATCH] Replace hard-coded type approximations with references to the new class-based LitTypes. PiperOrigin-RevId: 463636591 --- lit_nlp/api/types.py | 10 +- lit_nlp/api/types_test.py | 6 -- .../client/elements/interpreter_controls.ts | 69 +++++++------- lit_nlp/client/lib/generated_text_utils.ts | 5 +- .../client/lib/generated_text_utils_test.ts | 3 +- lit_nlp/client/lib/lit_types.ts | 34 +++++-- lit_nlp/client/lib/lit_types_utils.ts | 95 +++++++++++++++++-- lit_nlp/client/lib/lit_types_utils_test.ts | 45 ++++++++- lit_nlp/client/lib/types.ts | 44 +-------- lit_nlp/client/lib/utils.ts | 16 ++-- lit_nlp/client/modules/attention_module.ts | 6 +- .../client/modules/classification_module.ts | 26 +++-- .../counterfactual_explainer_module.ts | 4 +- lit_nlp/client/modules/curves_module.ts | 18 ++-- lit_nlp/client/modules/data_table_module.ts | 5 +- .../client/modules/datapoint_editor_module.ts | 13 +-- .../modules/feature_attribution_module.ts | 22 +++-- .../client/modules/generated_image_module.ts | 16 ++-- .../client/modules/generated_text_module.ts | 5 +- lit_nlp/client/modules/generator_module.ts | 48 +++++----- .../client/modules/lm_prediction_module.ts | 11 ++- lit_nlp/client/modules/multilabel_module.ts | 4 +- lit_nlp/client/modules/pdp_module.ts | 9 +- lit_nlp/client/modules/regression_module.ts | 4 +- .../modules/salience_clustering_module.ts | 15 +-- lit_nlp/client/modules/salience_map_module.ts | 18 ++-- lit_nlp/client/modules/scalar_module.ts | 14 ++- .../modules/sequence_salience_module.ts | 4 +- lit_nlp/client/modules/span_graph_module.ts | 8 +- lit_nlp/client/modules/tcav_module.ts | 5 +- lit_nlp/client/modules/tda_module.ts | 28 +++--- lit_nlp/client/services/api_service.ts | 5 +- .../client/services/classification_service.ts | 7 +- lit_nlp/client/services/data_service.ts | 33 ++++--- lit_nlp/client/services/group_service.ts | 10 +- lit_nlp/client/services/state_service.ts | 18 ++-- 36 files changed, 414 insertions(+), 269 deletions(-) diff --git a/lit_nlp/api/types.py b/lit_nlp/api/types.py index 34951216..f658eb51 100644 --- a/lit_nlp/api/types.py +++ b/lit_nlp/api/types.py @@ -486,26 +486,26 @@ class MultiFieldMatcher(LitType): @attr.s(auto_attribs=True, frozen=True, kw_only=True) -class _Salience(LitType): +class Salience(LitType): """Metadata about a returned salience map.""" autorun: bool = False # If the saliency technique is automatically run. signed: bool # If the returned values are signed. @attr.s(auto_attribs=True, frozen=True, kw_only=True) -class TokenSalience(_Salience): +class TokenSalience(Salience): """Metadata about a returned token salience map.""" default: dtypes.TokenSalience = None @attr.s(auto_attribs=True, frozen=True, kw_only=True) -class FeatureSalience(_Salience): +class FeatureSalience(Salience): """Metadata about a returned feature salience map.""" default: dtypes.FeatureSalience = None @attr.s(auto_attribs=True, frozen=True, kw_only=True) -class ImageSalience(_Salience): +class ImageSalience(Salience): """Metadata about a returned image saliency. The data is returned as an image in the base64 URL encoded format, e.g., @@ -515,7 +515,7 @@ class ImageSalience(_Salience): @attr.s(auto_attribs=True, frozen=True, kw_only=True) -class SequenceSalience(_Salience): +class SequenceSalience(Salience): """Metadata about a returned sequence salience map.""" default: dtypes.SequenceSalienceMap = None diff --git a/lit_nlp/api/types_test.py b/lit_nlp/api/types_test.py index ad7bfb31..61e17c22 100644 --- a/lit_nlp/api/types_test.py +++ b/lit_nlp/api/types_test.py @@ -3,15 +3,9 @@ from lit_nlp.api import types from google3.testing.pybase import googletest -NUM_TYPES = 41 - class TypesTest(googletest.TestCase): - def test_num_littypes(self): - num_types = len(types.all_littypes()) - self.assertEqual(num_types, NUM_TYPES) - def test_inherit_parent_default_type(self): lit_type = types.StringLitType() self.assertIsInstance(lit_type.default, str) diff --git a/lit_nlp/client/elements/interpreter_controls.ts b/lit_nlp/client/elements/interpreter_controls.ts index 2211dfaa..ba1d90b4 100644 --- a/lit_nlp/client/elements/interpreter_controls.ts +++ b/lit_nlp/client/elements/interpreter_controls.ts @@ -19,14 +19,14 @@ import './checkbox'; import '@material/mwc-icon'; -import {property} from 'lit/decorators'; -import {customElement} from 'lit/decorators'; -import { html} from 'lit'; +import {html} from 'lit'; +import {customElement, property} from 'lit/decorators'; import {observable} from 'mobx'; import {ReactiveElement} from '../lib/elements'; +import {CategoryLabel, FieldMatcher, LitType, LitTypeWithVocab, MultiFieldMatcher, Scalar, SparseMultilabel} from '../lib/lit_types'; import {styles as sharedStyles} from '../lib/shared_styles.css'; -import {LitType, Spec} from '../lib/types'; +import {Spec} from '../lib/types'; import {isLitSubtype} from '../lib/utils'; import {styles} from './interpreter_controls.css'; @@ -101,23 +101,25 @@ export class InterpreterControls extends ReactiveElement { renderControls() { const spec = this.spec as Spec; return Object.keys(spec).map(name => { - // Ensure a default value for any of the options provided for setting. if (this.settings[name] == null) { - if (isLitSubtype(spec[name], 'SparseMultilabel')) { - this.settings[name] = spec[name].default as string[]; + if (spec[name] instanceof SparseMultilabel) { + this.settings[name] = (spec[name] as SparseMultilabel).default; } // If select all is True, default value is all of vocab. - if (isLitSubtype(spec[name], 'MultiFieldMatcher')) { - this.settings[name] = spec[name].select_all!? - spec[name].vocab as string[] : - spec[name].default as string[]; + if (spec[name] instanceof MultiFieldMatcher) { + const fieldSpec = spec[name] as MultiFieldMatcher; + this.settings[name] = fieldSpec.select_all ? + fieldSpec.vocab as string[] : + fieldSpec.default; } // FieldMatcher has its vocab set outside of this element. - else if (isLitSubtype(spec[name], ['CategoryLabel', 'FieldMatcher'])) { + else if ( + spec[name] instanceof CategoryLabel || + spec[name] instanceof FieldMatcher) { + const {vocab} = spec[name] as LitTypeWithVocab; this.settings[name] = - spec[name].vocab != null && spec[name].vocab!.length > 0 ? - spec[name].vocab![0] : ''; + vocab != null && vocab.length > 0 ? vocab[0] : ''; } else { this.settings[name] = spec[name].default as string; } @@ -126,7 +128,7 @@ export class InterpreterControls extends ReactiveElement { return html`
- ${(required ? '*':'') + name} + ${(required ? '*' : '') + name}
${this.renderControl(name, spec[name])}
`; @@ -134,21 +136,22 @@ export class InterpreterControls extends ReactiveElement { } renderControl(name: string, controlType: LitType) { - if (isLitSubtype(controlType, ['SparseMultilabel', 'MultiFieldMatcher'])) { + if (controlType instanceof SparseMultilabel || + controlType instanceof MultiFieldMatcher) { + const {vocab} = controlType as LitTypeWithVocab; // Render checkboxes, with the first item selected. - const renderCheckboxes = - () => controlType.vocab!.map(option => { + const renderCheckboxes = () => vocab.map(option => { // tslint:disable-next-line:no-any const change = (e: any) => { if (e.target.checked) { (this.settings[name] as string[]).push(option); } else { - this.settings[name] = (this.settings[name] as string[]).filter( - item => item !== option); + this.settings[name] = (this.settings[name] as string[]) + .filter(item => item !== option); } }; - const isSelected = (this.settings[name] as string[]).indexOf( - option) !== -1; + const isSelected = + (this.settings[name] as string[]).indexOf(option) !== -1; return html` @@ -156,29 +159,31 @@ export class InterpreterControls extends ReactiveElement { `; }); return html`
${renderCheckboxes()}
`; - } else if (isLitSubtype(controlType, ['CategoryLabel', 'FieldMatcher'])) { + } else if ( + controlType instanceof CategoryLabel || + controlType instanceof FieldMatcher) { + const {vocab} = controlType as LitTypeWithVocab; // Render a dropdown, with the first item selected. const updateDropdown = (e: Event) => { const select = (e.target as HTMLSelectElement); - this.settings[name] = controlType.vocab![select?.selectedIndex || 0]; + this.settings[name] = vocab[select?.selectedIndex || 0]; }; - const options = controlType.vocab!.map((option, optionIndex) => { + const options = vocab.map((option, optionIndex) => { return html` `; }); const defaultValue = - controlType.vocab != null && controlType.vocab.length > 0 ? - controlType.vocab[0] : ''; + vocab != null && vocab.length > 0 ? + vocab[0] : + ''; return html``; - } else if (isLitSubtype(controlType, ['Scalar'])) { + } else if (controlType instanceof Scalar) { // Render a slider. - const step = controlType.step!; - const minVal = controlType.min_val!; - const maxVal = controlType.max_val!; + const {step, min_val: minVal, max_val: maxVal} = controlType; const updateSettings = (e: Event) => { const input = (e.target as HTMLInputElement); diff --git a/lit_nlp/client/lib/generated_text_utils.ts b/lit_nlp/client/lib/generated_text_utils.ts index e1bf6b15..01c6db88 100644 --- a/lit_nlp/client/lib/generated_text_utils.ts +++ b/lit_nlp/client/lib/generated_text_utils.ts @@ -20,7 +20,8 @@ */ import difflib from 'difflib'; -import {GeneratedTextCandidate, IndexedInput, Input, LitName, Preds, Spec} from './types'; +import {LitName, LitTypeWithParent} from './lit_types'; +import {GeneratedTextCandidate, IndexedInput, Input, Preds, Spec} from './types'; import {findSpecKeys, isLitSubtype} from './utils'; // tslint:disable-next-line:no-any difflib does not support Closure imports @@ -89,7 +90,7 @@ export function getAllReferenceTexts( // Search input fields: anything referenced in model's output spec const inputReferenceKeys = new Set(); for (const outKey of findSpecKeys(outputSpec, GENERATION_TYPES)) { - const parent = outputSpec[outKey].parent; + const {parent} = outputSpec[outKey] as LitTypeWithParent; if (parent && dataSpec[parent]) { inputReferenceKeys.add(parent); } diff --git a/lit_nlp/client/lib/generated_text_utils_test.ts b/lit_nlp/client/lib/generated_text_utils_test.ts index 49fde372..eaf45d5a 100644 --- a/lit_nlp/client/lib/generated_text_utils_test.ts +++ b/lit_nlp/client/lib/generated_text_utils_test.ts @@ -18,8 +18,9 @@ import 'jasmine'; import {canonicalizeGenerationResults, getAllOutputTexts, getAllReferenceTexts, getFlatTexts, getTextDiff} from './generated_text_utils'; +import {LitType} from './lit_types'; import {createLitType} from './lit_types_utils'; -import {Input, LitType, Preds, Spec} from './types'; +import {Input, Preds, Spec} from './types'; function textSegmentType(): LitType { return createLitType('TextSegment', { diff --git a/lit_nlp/client/lib/lit_types.ts b/lit_nlp/client/lib/lit_types.ts index bb4a4ff1..0dfa9b4d 100644 --- a/lit_nlp/client/lib/lit_types.ts +++ b/lit_nlp/client/lib/lit_types.ts @@ -29,14 +29,15 @@ function registered(target: any) { REGISTRY[target.name] = target; } -const registryKeys = Object.keys(REGISTRY) as ReadonlyArray; +const registryKeys : string[] = Object.keys(REGISTRY); /** * The types of all LitTypes in the registry, e.g. * 'StringLitType' | 'TextSegment' ... */ export type LitName = typeof registryKeys[number]; -type LitClass = 'LitType'; +/** A type alias for the LitType class. */ +export type LitClass = 'LitType'; type ScoredTextCandidates = Array<[text: string, score: number|null]>; /** @@ -56,12 +57,26 @@ export class LitType { // TODO(b/162269499): Replace this with `unknown` after migration. // tslint:disable-next-line:no-any readonly default: any|undefined = null; + // If this type is created from an Annotator. + annotated: boolean = false; // TODO(b/162269499): Update to camel case once we've replaced old LitType. show_in_data_table: boolean = false; // TODO(b/162269499): Add isCompatible functionality. } +/** A type alias for LitType with an align property. */ +export type LitTypeWithAlign = LitType&{align: string}; + +/** A type alias for LitType with a null idx property. */ +export type LitTypeWithNullIdx = LitType&{null_idx: number}; + +/** A type alias for LitType with a parent property. */ +export type LitTypeWithParent = LitType&{parent: string}; + +/** A type alias for LitType with a vocab property. */ +export type LitTypeWithVocab = LitType&{vocab: string[]}; + /** * A string LitType. */ @@ -420,6 +435,10 @@ export class SparseMultilabelPreds extends _StringCandidateList { parent?: string = undefined; } +// TODO(b/162269499): Rename FieldMatcher to SingleFieldMatcher. +/** A type alias for FieldMatcher or MultiFieldMatcher. */ +export type LitTypeOfFieldMatcher = FieldMatcher|MultiFieldMatcher; + /** * For matching spec fields. * @@ -462,7 +481,8 @@ export class MultiFieldMatcher extends LitType { /** * Metadata about a returned salience map. */ -class _Salience extends LitType { +@registered +export class Salience extends LitType { /** If the saliency technique is automatically run. */ autorun: boolean = false; /** If the returned values are signed. */ @@ -473,14 +493,14 @@ class _Salience extends LitType { * Metadata about a returned token salience map. */ @registered -export class TokenSalience extends _Salience { +export class TokenSalience extends Salience { } /** * Metadata about a returned feature salience map. */ @registered -export class FeatureSalience extends _Salience { +export class FeatureSalience extends Salience { // TODO(b/162269499): Add Typescript dtypes so that we can set default types. } @@ -490,14 +510,14 @@ export class FeatureSalience extends _Salience { * data:image/jpg;base64,w4J3k1Bfa... */ @registered -export class ImageSalience extends _Salience { +export class ImageSalience extends Salience { } /** * Metadata about a returned sequence salience map. */ @registered -export class SequenceSalience extends _Salience { +export class SequenceSalience extends Salience { } /** diff --git a/lit_nlp/client/lib/lit_types_utils.ts b/lit_nlp/client/lib/lit_types_utils.ts index 2899054c..ac6b0788 100644 --- a/lit_nlp/client/lib/lit_types_utils.ts +++ b/lit_nlp/client/lib/lit_types_utils.ts @@ -1,6 +1,28 @@ +/** + * @license + * Copyright 2020 Google LLC + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// For consistency with types.ts. +// tslint:disable: enforce-name-casing + import {Spec} from '../lib/types'; import {LitName, LitType, REGISTRY} from './lit_types'; +import {LitMetadata} from './types'; + /** * Creates and returns a new LitType instance. @@ -9,17 +31,20 @@ import {LitName, LitType, REGISTRY} from './lit_types'; * For example, {'show_in_data_table': true}. */ export function createLitType( - typeName: LitName, - constructorParams: {[key: string]: unknown} = {}){ + typeName: LitName, constructorParams: {[key: string]: unknown} = {}) { const litType = REGISTRY[typeName]; - // tslint:disable-next-line:no-any const newType = new (litType as any)(); newType.__name__ = typeName; newType.__mro__ = getMethodResolutionOrder(newType); + // Excluded properties are passed through in the Python serialization + // of LitTypes and can be ignored by the frontend. + const excluded = ['__mro__']; for (const key in constructorParams) { - if (key in newType) { + if (excluded.includes(key)) { + continue; + } else if (key in newType) { newType[key] = constructorParams[key]; } else { throw new Error( @@ -30,6 +55,60 @@ export function createLitType( return newType; } + +interface SerializedSpec { + [key: string]: {__name__: string}; +} + +/** + * Converts serialized LitTypes within a Spec into LitType instances. + */ +export function deserializeLitTypesInSpec(serializedSpec: SerializedSpec): Spec { + const typedSpec: Spec = {}; + for (const key of Object.keys(serializedSpec)) { + typedSpec[key] = + createLitType(serializedSpec[key].__name__, serializedSpec[key] as {}); + } + return typedSpec; +} + + +/** + * Converts serialized LitTypes within the LitMetadata into LitType instances. + */ +export function deserializeLitTypesInLitMetadata(metadata: LitMetadata): + LitMetadata { + for (const model of Object.keys(metadata.models)) { + metadata.models[model].spec.input = + deserializeLitTypesInSpec(metadata.models[model].spec.input); + metadata.models[model].spec.output = + deserializeLitTypesInSpec(metadata.models[model].spec.output); + } + + for (const dataset of Object.keys(metadata.datasets)) { + metadata.datasets[dataset].spec = + deserializeLitTypesInSpec(metadata.datasets[dataset].spec); + } + + for (const generator of Object.keys(metadata.generators)) { + metadata.generators[generator].configSpec = + deserializeLitTypesInSpec(metadata.generators[generator].configSpec); + metadata.generators[generator].metaSpec = + deserializeLitTypesInSpec(metadata.generators[generator].metaSpec); + } + + for (const interpreter of Object.keys(metadata.interpreters)) { + metadata.interpreters[interpreter].configSpec = deserializeLitTypesInSpec( + metadata.interpreters[interpreter].configSpec); + metadata.interpreters[interpreter].metaSpec = + deserializeLitTypesInSpec(metadata.interpreters[interpreter].metaSpec); + } + + metadata.littypes = deserializeLitTypesInSpec(metadata.littypes); + return metadata; +} + + /** * Returns the method resolution order for a given litType. * This is for compatability with references to non-class-based LitTypes, @@ -53,8 +132,7 @@ export function getMethodResolutionOrder(litType: LitType): string[] { * @param litType: The LitType to check. * @param typesToFind: Either a single or list of parent LitType candidates. */ -export function isLitSubtype( - litType: LitType, typesToFind: LitName|LitName[]) { +export function isLitSubtype(litType: LitType, typesToFind: LitName|LitName[]) { if (litType == null) return false; if (typeof typesToFind === 'string') { @@ -63,7 +141,7 @@ export function isLitSubtype( for (const typeName of typesToFind) { // tslint:disable-next-line:no-any - const registryType : any = REGISTRY[typeName]; + const registryType: any = REGISTRY[typeName]; if (litType instanceof registryType) { return true; @@ -80,6 +158,5 @@ export function isLitSubtype( export function findSpecKeys( spec: Spec, typesToFind: LitName|LitName[]): string[] { return Object.keys(spec).filter( - key => isLitSubtype( - spec[key] as LitType, typesToFind)); + key => isLitSubtype(spec[key], typesToFind)); } diff --git a/lit_nlp/client/lib/lit_types_utils_test.ts b/lit_nlp/client/lib/lit_types_utils_test.ts index 800aefc0..d239618d 100644 --- a/lit_nlp/client/lib/lit_types_utils_test.ts +++ b/lit_nlp/client/lib/lit_types_utils_test.ts @@ -16,7 +16,7 @@ describe('createLitType test', () => { const result = litTypesUtils.createLitType('Scalar'); expect(result).toEqual(expected); expect(result instanceof litTypes.Scalar).toEqual(true); - }); + }); it('creates with constructor params', () => { const expected = new litTypes.StringLitType(); @@ -89,8 +89,42 @@ describe('isLitSubtype test', () => { }); +describe('deserializeLitTypesInSpec test', () => { + // TODO(b/162269499): Add test for deserializeLitTypesInLitMetadata. + const testSpec = { + 'probabilities': { + '__class__': 'LitType', + '__name__': 'MulticlassPreds', + '__mro__': ['MulticlassPreds', 'LitType', 'object'], + 'required': true, + 'vocab': ['0', '1'], + 'null_idx': 0, + 'parent': 'label' + }, + 'pooled_embs': { + '__class__': 'LitType', + '__name__': 'Embeddings', + '__mro__': ['Embeddings', 'LitType', 'object'], + 'required': true + } + }; + + it('returns serialized littypes', () => { + expect(testSpec['probabilities'] instanceof litTypes.MulticlassPreds) + .toBe(false); + const result = litTypesUtils.deserializeLitTypesInSpec(testSpec); + expect(result['probabilities']) + .toEqual(litTypesUtils.createLitType( + 'MulticlassPreds', + {'vocab': ['0', '1'], 'null_idx': 0, 'parent': 'label'})); + expect(result['probabilities'] instanceof litTypes.MulticlassPreds) + .toBe(true); + }); +}); + + describe('findSpecKeys test', () => { - // TODO(cjqian): Add original utils_test test after adding more types. + // TODO(cjqian): Add original litTypesUtils.test test after adding more types. const spec: Spec = { 'scalar_foo': new litTypes.Scalar(), 'segment': new litTypes.StringLitType(), @@ -105,9 +139,9 @@ describe('findSpecKeys test', () => { ]); // Keys are in spec. - expect(litTypesUtils.findSpecKeys(spec, ['StringLitType', 'Scalar'])).toEqual([ - 'scalar_foo', 'segment', 'generated_text' - ]); + expect(litTypesUtils.findSpecKeys(spec, [ + 'StringLitType', 'Scalar' + ])).toEqual(['scalar_foo', 'segment', 'generated_text']); }); it('handles empty spec keys', () => { @@ -118,4 +152,5 @@ describe('findSpecKeys test', () => { expect(() => litTypesUtils.findSpecKeys(spec, '')).toThrowError(); expect(() => litTypesUtils.findSpecKeys(spec, 'NotAType')).toThrowError(); }); + }); diff --git a/lit_nlp/client/lib/types.ts b/lit_nlp/client/lib/types.ts index 039e22bd..423b392f 100644 --- a/lit_nlp/client/lib/types.ts +++ b/lit_nlp/client/lib/types.ts @@ -19,56 +19,16 @@ import * as d3 from 'd3'; import {TemplateResult} from 'lit'; +import {LitName, LitType} from './lit_types'; import {chunkWords, isLitSubtype} from './utils'; // tslint:disable-next-line:no-any export type D3Selection = d3.Selection; -export type LitClass = 'LitType'; -export type LitName = 'type'|'LitType'|'StringLitType'|'TextSegment'| - 'GeneratedText'|'GeneratedTextCandidates'|'ReferenceTexts'|'URL'| - 'SearchQuery'|'Tokens'|'TokenTopKPreds'|'Scalar'|'RegressionScore'| - 'CategoryLabel'|'MulticlassPreds'|'SequenceTags'|'SpanLabels'|'EdgeLabels'| - 'MultiSegmentAnnotations'|'Embeddings'|'TokenGradients'|'TokenEmbeddings'| - 'AttentionHeads'|'SparseMultilabel'|'FieldMatcher'|'MultiFieldMatcher'| - 'Gradients'|'Boolean'|'TokenSalience'|'ImageBytes'|'SparseMultilabelPreds'| - 'ImageGradients'|'ImageSalience'|'SequenceSalience'|'ReferenceScores'| - 'FeatureSalience'|'TopTokens'|'CurveDataPoints'|'InfluentialExamples'| - 'GeneratedURL'; - +// TODO(b/162269499): Replace this with class-based lists. export const listFieldTypes: LitName[] = ['Tokens', 'SequenceTags', 'SpanLabels', 'EdgeLabels', 'SparseMultilabel']; -export interface LitType { - __class__: LitClass|'type'; - __name__: LitName; - __mro__: string[]; - parent?: string; - align?: string; - align_in?: string; - align_out?: string; - vocab?: string[]; - null_idx?: number; - required?: boolean; - annotated?: boolean; - default?: string|string[]|number|number[]; - spec?: string; - types?: LitName|LitName[]; - min_val?: number; - max_val?: number; - step?: number; - exclusive?: boolean; - background?: boolean; - separator?: string; - autorun?: boolean; - signed?: boolean; - mask_token?: string; - token_prefix?: string; - select_all?: boolean; - autosort?: boolean; - show_in_data_table?: boolean; -} - export interface Spec { [key: string]: LitType; } diff --git a/lit_nlp/client/lib/utils.ts b/lit_nlp/client/lib/utils.ts index 06eb2910..c53cabbd 100644 --- a/lit_nlp/client/lib/utils.ts +++ b/lit_nlp/client/lib/utils.ts @@ -25,7 +25,8 @@ import {html, TemplateResult} from 'lit'; import {unsafeHTML} from 'lit/directives/unsafe-html.js'; import {marked} from 'marked'; -import {FacetMap, LitName, LitType, ModelInfoMap, Spec} from './types'; +import {LitName, LitType, LitTypeWithParent, MulticlassPreds} from './lit_types'; +import {FacetMap, ModelInfoMap, Spec} from './types'; /** Calculates the mean for a list of numbers */ export function mean(values: number[]): number { @@ -305,14 +306,17 @@ export function doesInputSpecContain( /** Returns if a LitType specifies binary classification. */ export function isBinaryClassification(litType: LitType) { - const predictionLabels = litType.vocab!; - const nullIdx = litType.null_idx; - return predictionLabels.length === 2 && nullIdx != null; + if (litType instanceof MulticlassPreds) { + const {vocab, null_idx: nullIdx} = litType; + return vocab.length === 2 && nullIdx != null; + } + + return false; } /** Returns if a LitType has a parent field. */ export function hasParent(litType: LitType) { - return litType.parent != null; + return (litType as LitTypeWithParent).parent != null; } /** @@ -518,4 +522,4 @@ export function linearSpace( values.push(minValue + i * step); } return values; -} \ No newline at end of file +} diff --git a/lit_nlp/client/modules/attention_module.ts b/lit_nlp/client/modules/attention_module.ts index de517036..6dda327d 100644 --- a/lit_nlp/client/modules/attention_module.ts +++ b/lit_nlp/client/modules/attention_module.ts @@ -27,6 +27,7 @@ import {observable} from 'mobx'; import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; +import {AttentionHeads as AttentionHeadsLitType} from '../lib/lit_types'; import {IndexedInput, ModelInfoMap, SCROLL_SYNC_CSS_CLASS, Spec} from '../lib/types'; import {doesOutputSpecContain, findSpecKeys, getTextWidth, getTokOffsets, sumArray} from '../lib/utils'; import {FocusService} from '../services/services'; @@ -135,13 +136,14 @@ export class AttentionModule extends LitModule { private renderAttnHead() { const outputSpec = this.appState.currentModelSpecs[this.model].spec.output; - const fieldSpec = outputSpec[this.selectedLayer!]; + const fieldSpec = + outputSpec[this.selectedLayer!] as AttentionHeadsLitType; // Tokens involved in the attention. const inToks = (this.preds!)[fieldSpec.align_in!] as Tokens; const outToks = (this.preds!)[fieldSpec.align_out!] as Tokens; - const fontFamily = "'Share Tech Mono', monospace"; + const fontFamily = '\'Share Tech Mono\', monospace'; const fontSize = 12; const defaultCharWidth = 6.5; const font = `${fontSize}px ${fontFamily}`; diff --git a/lit_nlp/client/modules/classification_module.ts b/lit_nlp/client/modules/classification_module.ts index b4473d58..df075417 100644 --- a/lit_nlp/client/modules/classification_module.ts +++ b/lit_nlp/client/modules/classification_module.ts @@ -25,6 +25,7 @@ import {observable} from 'mobx'; import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; import {ColumnHeader, SortableTemplateResult, TableData} from '../elements/table'; +import {MulticlassPreds} from '../lib/lit_types'; import {styles as sharedStyles} from '../lib/shared_styles.css'; import {IndexedInput, ModelInfoMap, Spec} from '../lib/types'; import {doesOutputSpecContain, findSpecKeys} from '../lib/utils'; @@ -130,7 +131,7 @@ export class ClassificationModule extends LitModule { const predClassKey = this.dataService.getColumnName( model, predKey, CalculatedColumnType.PREDICTED_CLASS); labeledPredictions[topLevelKey] = {}; - const {parent, vocab} = output[predKey]; + const {parent, vocab} = output[predKey] as MulticlassPreds; const scores = inputs.map(input => this.dataService.getVal(input.id, topLevelKey)); const predictedClasses = @@ -163,20 +164,25 @@ export class ClassificationModule extends LitModule { } override render() { - const hasGroundTruth = this.appState.currentModels.some(model => - Object.values(this.appState.currentModelSpecs[model].spec.output) - .some(feature => feature.parent != null)); + // TODO(b/162269499): Check that feature.parent is within the spec. + const hasGroundTruth = this.appState.currentModels.some( + model => + Object.values(this.appState.currentModelSpecs[model].spec.output) + .some( + feature => feature instanceof MulticlassPreds && + feature.parent != null)); return html`
- ${Object.entries(this.labeledPredictions) - .map(([fieldName, labelRow], i, arr) => { - const featureTable = - this.renderFeatureTable(labelRow, hasGroundTruth); - return arr.length === 1 ? featureTable: html` + ${ + Object.entries(this.labeledPredictions) + .map(([fieldName, labelRow], i, arr) => { + const featureTable = + this.renderFeatureTable(labelRow, hasGroundTruth); + return arr.length === 1 ? featureTable : html` ${featureTable} `; - })} + })}
diff --git a/lit_nlp/client/modules/counterfactual_explainer_module.ts b/lit_nlp/client/modules/counterfactual_explainer_module.ts index 46dff50a..021eb2d8 100644 --- a/lit_nlp/client/modules/counterfactual_explainer_module.ts +++ b/lit_nlp/client/modules/counterfactual_explainer_module.ts @@ -31,6 +31,7 @@ import {styleMap} from 'lit/directives/style-map'; import {observable} from 'mobx'; import {LitModule} from '../core/lit_module'; +import {MulticlassPreds} from '../lib/lit_types'; import {ModelInfoMap, Spec} from '../lib/types'; import {findSpecKeys, range} from '../lib/utils'; import {SalienceCmap, SignedSalienceCmap} from '../services/color_service'; @@ -282,7 +283,8 @@ export class CounterfactualExplainerModule extends LitModule { this.selectedPredKey = predKeys[0]; } - const predictionLabels = outputSpec[this.selectedPredKey].vocab; + const predictionLabels = + (outputSpec[this.selectedPredKey] as MulticlassPreds).vocab; const classes: number[] = (predictionLabels == null) ? [] : range(predictionLabels.length); if (!classes.includes(this.selectedClass)) { diff --git a/lit_nlp/client/modules/curves_module.ts b/lit_nlp/client/modules/curves_module.ts index ed54400f..bef1cff5 100644 --- a/lit_nlp/client/modules/curves_module.ts +++ b/lit_nlp/client/modules/curves_module.ts @@ -24,6 +24,7 @@ import {action, computed, observable} from 'mobx'; import {FacetsChange} from '../core/faceting_control'; import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; +import {MulticlassPreds} from '../lib/lit_types'; import {GroupedExamples, IndexedInput, ModelInfoMap, SCROLL_SYNC_CSS_CLASS, Spec} from '../lib/types'; import {doesOutputSpecContain, findSpecKeys, hasParent} from '../lib/utils'; import {GroupService} from '../services/services'; @@ -176,16 +177,15 @@ export class CurvesModule extends LitModule { for (const modelName of this.appState.currentModels) { const modelSpec = this.appState.metadata.models[modelName].spec; if (this.predKey in modelSpec.output) { - if (modelSpec.output[this.predKey].vocab == null) { - continue; + const fieldSpec = modelSpec.output[this.predKey]; + if (fieldSpec instanceof MulticlassPreds) { + // Find default positive label by finding first index that isn't + // the null index for a predicted class vocab. + this.selectedPositiveLabelIndex = + fieldSpec.vocab.findIndex((elem, i) => i !== fieldSpec.null_idx); + + return fieldSpec.vocab; } - // Find default positive label by finding first index that isn't - // the null index for a predicted class vocab. - this.selectedPositiveLabelIndex = - modelSpec.output[this.predKey].vocab!.findIndex( - (elem, i) => i !== modelSpec.output[this.predKey].null_idx); - - return modelSpec.output[this.predKey].vocab!; } } return []; diff --git a/lit_nlp/client/modules/data_table_module.ts b/lit_nlp/client/modules/data_table_module.ts index 96b3183a..ddaff5f8 100644 --- a/lit_nlp/client/modules/data_table_module.ts +++ b/lit_nlp/client/modules/data_table_module.ts @@ -28,8 +28,9 @@ import {computed, observable} from 'mobx'; import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; import {ColumnHeader, DataTable, TableData} from '../elements/table'; +import {LitType, LitTypeWithVocab} from '../lib/lit_types'; import {styles as sharedStyles} from '../lib/shared_styles.css'; -import {formatForDisplay, IndexedInput, LitType, ModelInfoMap, Spec} from '../lib/types'; +import {formatForDisplay, IndexedInput, ModelInfoMap, Spec} from '../lib/types'; import {compareArrays, isLitSubtype} from '../lib/utils'; import {DataService, FocusService, SelectionService} from '../services/services'; @@ -76,7 +77,7 @@ export class DataTableModule extends LitModule { @computed get keys(): ColumnHeader[] { const createColumnHeader = (name: string, type: LitType) => { - const header = {name, vocab: type.vocab}; + const header = {name, vocab: (type as LitTypeWithVocab).vocab}; if (isLitSubtype(type, 'Boolean')) { header.vocab = ['✔', ' ']; } diff --git a/lit_nlp/client/modules/datapoint_editor_module.ts b/lit_nlp/client/modules/datapoint_editor_module.ts index 262865bb..d2d5d54f 100644 --- a/lit_nlp/client/modules/datapoint_editor_module.ts +++ b/lit_nlp/client/modules/datapoint_editor_module.ts @@ -27,9 +27,10 @@ import {computed, observable, when} from 'mobx'; import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; +import {LitTypeWithVocab, SparseMultilabel, StringLitType} from '../lib/lit_types'; import {styles as sharedStyles} from '../lib/shared_styles.css'; import {AnnotationCluster, defaultValueByField, EdgeLabel, formatAnnotationCluster, formatEdgeLabel, formatSpanLabel, IndexedInput, Input, ModelInfoMap, SCROLL_SYNC_CSS_CLASS, SpanLabel, Spec} from '../lib/types'; -import {isLitSubtype, findSpecKeys} from '../lib/utils'; +import {findSpecKeys, isLitSubtype} from '../lib/utils'; import {GroupService} from '../services/group_service'; import {SelectionService} from '../services/selection_service'; @@ -86,8 +87,8 @@ export class DatapointEditorModule extends LitModule { // Skip fields with value type string[] const fieldSpec = this.appState.currentDatasetSpec[key]; - const isListField = isLitSubtype( - fieldSpec, ['SparseMultilabel', 'Tokens', 'SequenceTags']); + // TODO(b/162269499) Replace this with list check. + const isListField = fieldSpec.__mro__.includes('_List'); if (isListField) continue; dataTextKeys.push(key); } @@ -109,10 +110,10 @@ export class DatapointEditorModule extends LitModule { const fieldSpec = this.appState.currentDatasetSpec[key]; let calculateStringLength : ((s: string) => number) | ((s: string[]) => number); - if (isLitSubtype(fieldSpec, ['StringLitType', 'TextSegment'])) { + if (fieldSpec instanceof StringLitType) { calculateStringLength = (s: string) => s.length; } - else if (isLitSubtype(fieldSpec, 'SparseMultilabel')) { + else if (fieldSpec instanceof SparseMultilabel) { const separator = fieldSpec.separator; calculateStringLength = (s: string[]) => Object.values(s).join(separator).length; @@ -538,7 +539,7 @@ export class DatapointEditorModule extends LitModule { 'left-align': false }; const fieldSpec = this.appState.currentDatasetSpec[key]; - const vocab = fieldSpec?.vocab; + const {vocab} = fieldSpec as LitTypeWithVocab; if (vocab != null && !isLitSubtype(fieldSpec, 'SparseMultilabel')) { renderInput = () => renderCategoricalInput(vocab); } else if (this.groupService.categoricalFeatureNames.includes(key)) { diff --git a/lit_nlp/client/modules/feature_attribution_module.ts b/lit_nlp/client/modules/feature_attribution_module.ts index d044694e..0205bd70 100644 --- a/lit_nlp/client/modules/feature_attribution_module.ts +++ b/lit_nlp/client/modules/feature_attribution_module.ts @@ -28,9 +28,10 @@ import {FacetsChange} from '../core/faceting_control'; import {LitModule} from '../core/lit_module'; import {InterpreterClick, InterpreterSettings} from '../elements/interpreter_controls'; import {SortableTemplateResult, TableData} from '../elements/table'; +import {FieldMatcher} from '../lib/lit_types'; import {IndexedInput, ModelInfoMap} from '../lib/types'; import * as utils from '../lib/utils'; -import {findSpecKeys, isLitSubtype} from '../lib/utils'; +import {findSpecKeys} from '../lib/utils'; import {SignedSalienceCmap} from '../services/color_service'; import {NumericFeatureBins} from '../services/group_service'; import {AppState, GroupService} from '../services/services'; @@ -213,10 +214,12 @@ export class FeatureAttributionModule extends LitModule { const defaultCallConfig: {[key: string]: unknown} = {}; for (const [configKey, configInfo] of Object.entries(configSpec)) { - if (configInfo.default) { - defaultCallConfig[configKey] = configInfo.default; - } else if (configInfo.vocab && configInfo.vocab.length) { - defaultCallConfig[configKey] = configInfo.vocab[0]; + if (configInfo instanceof FieldMatcher) { + if (configInfo.default) { + defaultCallConfig[configKey] = configInfo.default; + } else if (configInfo.vocab && configInfo.vocab.length) { + defaultCallConfig[configKey] = configInfo.vocab[0]; + } } } @@ -342,13 +345,12 @@ export class FeatureAttributionModule extends LitModule { const {configSpec, description} = this.appState.metadata.interpreters[interpreter]; const clonedSpec = Object.assign({}, configSpec); - for (const fieldName of Object.keys(clonedSpec)) { + for (const fieldSpec of Object.values(clonedSpec)) { // If the interpreter uses a field matcher, then get the matching field // names from the specified spec and use them as the vocab. - if (isLitSubtype(clonedSpec[fieldName], ['FieldMatcher'])) { - clonedSpec[fieldName].vocab = - this.appState.getSpecKeysFromFieldMatcher( - clonedSpec[fieldName], this.model); + if (fieldSpec instanceof FieldMatcher) { + fieldSpec.vocab = + this.appState.getSpecKeysFromFieldMatcher(fieldSpec, this.model); } } const interpreterControlClick = (event: CustomEvent) => { diff --git a/lit_nlp/client/modules/generated_image_module.ts b/lit_nlp/client/modules/generated_image_module.ts index cdb0ab4b..98080d7a 100644 --- a/lit_nlp/client/modules/generated_image_module.ts +++ b/lit_nlp/client/modules/generated_image_module.ts @@ -21,8 +21,9 @@ import {css, html} from 'lit'; import {observable} from 'mobx'; import {LitModule} from '../core/lit_module'; +import {GeneratedURL, LitName} from '../lib/lit_types'; import {styles as sharedStyles} from '../lib/shared_styles.css'; -import {IndexedInput, LitName, ModelInfoMap, Spec} from '../lib/types'; +import {IndexedInput, ModelInfoMap, Spec} from '../lib/types'; import {doesOutputSpecContain, isLitSubtype} from '../lib/utils'; /** @@ -113,15 +114,16 @@ export class GeneratedImageModule extends LitModule {
${Object.entries(this.generatedImages).map(([key, value]) => { - const keyType = output[key]; - if (isLitSubtype(keyType, GeneratedImageModule.supportedTypes)) { + const imageFieldSpec = output[key]; + if (isLitSubtype(imageFieldSpec, GeneratedImageModule.supportedTypes)) { return this.renderImage(key, value); } - const {align} = keyType; - if (isLitSubtype(keyType, 'GeneratedURL') && - align != null && align in this.generatedImages) { - return this.renderLink(key, value); + if (imageFieldSpec instanceof GeneratedURL) { + const {align} = imageFieldSpec; + if (align != null && align in this.generatedImages) { + return this.renderLink(key, value); + } } return null; diff --git a/lit_nlp/client/modules/generated_text_module.ts b/lit_nlp/client/modules/generated_text_module.ts index 8a267154..ed7b55f6 100644 --- a/lit_nlp/client/modules/generated_text_module.ts +++ b/lit_nlp/client/modules/generated_text_module.ts @@ -27,6 +27,7 @@ import {computed, observable} from 'mobx'; import {LitModule} from '../core/lit_module'; import {styles as visStyles} from '../elements/generated_text_vis.css'; import {DiffMode, GeneratedTextResult, GENERATION_TYPES} from '../lib/generated_text_utils'; +import {LitTypeWithParent, ReferenceScores} from '../lib/lit_types'; import {styles as sharedStyles} from '../lib/shared_styles.css'; import {IndexedInput, Input, ModelInfoMap, Spec} from '../lib/types'; import {doesOutputSpecContain, findSpecKeys, isLitSubtype} from '../lib/utils'; @@ -75,7 +76,7 @@ export class GeneratedTextModule extends LitModule { const refMap = new Map(); const textKeys = findSpecKeys(outputSpec, GENERATION_TYPES); for (const textKey of textKeys) { - const parent = outputSpec[textKey].parent; + const {parent} = outputSpec[textKey] as LitTypeWithParent; if (parent && dataSpec[parent]) { refMap.set(textKey, parent); } @@ -91,7 +92,7 @@ export class GeneratedTextModule extends LitModule { const refMap = new Map(); const scoreKeys = findSpecKeys(outputSpec, 'ReferenceScores'); for (const scoreKey of scoreKeys) { - const parent = outputSpec[scoreKey].parent; + const parent = (outputSpec[scoreKey] as ReferenceScores).parent; if (parent && dataSpec[parent]) { refMap.set(scoreKey, parent); } diff --git a/lit_nlp/client/modules/generator_module.ts b/lit_nlp/client/modules/generator_module.ts index 85da29d9..4a137655 100644 --- a/lit_nlp/client/modules/generator_module.ts +++ b/lit_nlp/client/modules/generator_module.ts @@ -19,21 +19,22 @@ import '../elements/interpreter_controls'; import '@material/mwc-icon'; import {MobxLitElement} from '@adobe/lit-mobx'; +import {css, html, TemplateResult} from 'lit'; // tslint:disable:no-new-decorators import {customElement} from 'lit/decorators'; -import {css, html, TemplateResult} from 'lit'; import {computed, observable} from 'mobx'; import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; import {TableData, TableEntry} from '../elements/table'; -import {CallConfig, formatForDisplay, IndexedInput, Input, LitName, ModelInfoMap, Spec} from '../lib/types'; +import {FieldMatcher, LitName, LitTypeOfFieldMatcher, MultiFieldMatcher} from '../lib/lit_types'; +import {styles as sharedStyles} from '../lib/shared_styles.css'; +import {CallConfig, formatForDisplay, IndexedInput, Input, ModelInfoMap, Spec} from '../lib/types'; import {flatten, isLitSubtype} from '../lib/utils'; import {GroupService} from '../services/group_service'; import {SelectionService, SliceService} from '../services/services'; import {styles} from './generator_module.css'; -import {styles as sharedStyles} from '../lib/shared_styles.css'; /** * Custom element for in-table add/remove controls. @@ -372,9 +373,9 @@ export class GeneratorModule extends LitModule { const row: {[key: string]: TableEntry} = {}; for (const key of fieldNames) { const editable = - !this.appState.currentModelRequiredInputSpecKeys.includes(key); - row[key] = editable ? this.renderEntry(generated.data, key) - : generated.data[key]; + !this.appState.currentModelRequiredInputSpecKeys.includes(key); + row[key] = editable ? this.renderEntry(generated.data, key) : + generated.data[key]; } row['Add/Remove'] = html` ${generators.map(genName => { - const spec = generatorsInfo[genName].configSpec; - const clonedSpec = JSON.parse(JSON.stringify(spec)) as Spec; - const description = generatorsInfo[genName].description; - for (const fieldName of Object.keys(clonedSpec)) { - // If the generator uses a field matcher, then get the matching - // field names from the specified spec and use them as the vocab. - if (isLitSubtype(clonedSpec[fieldName], - ['FieldMatcher','MultiFieldMatcher'])) { - clonedSpec[fieldName].vocab = - this.appState.getSpecKeysFromFieldMatcher( - clonedSpec[fieldName], this.modelName); - } - } - return html` + const spec = generatorsInfo[genName].configSpec; + const clonedSpec = JSON.parse(JSON.stringify(spec)) as Spec; + const description = generatorsInfo[genName].description; + for (const fieldSpec of Object.values(clonedSpec)) { + // If the generator uses a field matcher, then get the matching + // field names from the specified spec and use them as the vocab. + if (fieldSpec instanceof FieldMatcher || + fieldSpec instanceof MultiFieldMatcher) { + const fieldMatcher = fieldSpec as LitTypeOfFieldMatcher; + fieldMatcher.vocab = this.appState.getSpecKeysFromFieldMatcher( + fieldMatcher, this.modelName); + } + } + return html` `; - })} + })}
`; // clang-format on @@ -526,7 +527,8 @@ export class GeneratorModule extends LitModule { return isCategorical ? renderCategoricalInput() : renderFreeformInput(); } - static override shouldDisplayModule(modelSpecs: ModelInfoMap, datasetSpec: Spec) { + static override shouldDisplayModule( + modelSpecs: ModelInfoMap, datasetSpec: Spec) { return true; } } diff --git a/lit_nlp/client/modules/lm_prediction_module.ts b/lit_nlp/client/modules/lm_prediction_module.ts index 5bae68bf..4b784da0 100644 --- a/lit_nlp/client/modules/lm_prediction_module.ts +++ b/lit_nlp/client/modules/lm_prediction_module.ts @@ -24,6 +24,7 @@ import {classMap} from 'lit/directives/class-map'; import {computed, observable} from 'mobx'; import {LitModule} from '../core/lit_module'; +import {Tokens, TokenTopKPreds} from '../lib/lit_types'; import {IndexedInput, ModelInfoMap, Spec, TopKResult} from '../lib/types'; import {findMatchingIndices, findSpecKeys, isLitSubtype, replaceNth} from '../lib/utils'; @@ -74,13 +75,15 @@ export class LanguageModelPredictionModule extends LitModule { @computed private get outputTokensKey(): string { // This list is guaranteed to be non-empty due to checkModule() - return this.modelSpec.output[this.predKey].align as string; + return (this.modelSpec.output[this.predKey] as TokenTopKPreds).align as + string; } @computed private get outputTokensPrefix(): string { // This list is guaranteed to be non-empty due to checkModule() - return this.modelSpec.output[this.outputTokensKey].token_prefix as string; + return (this.modelSpec.output[this.outputTokensKey] as Tokens) + .token_prefix as string; } @computed @@ -97,7 +100,7 @@ export class LanguageModelPredictionModule extends LitModule { private get maskToken() { // Look at metadata for /input/ field matching output tokens name. return this.inputTokensKey ? - this.modelSpec.input[this.inputTokensKey].mask_token : + (this.modelSpec.input[this.inputTokensKey] as Tokens).mask_token : undefined; } @@ -382,7 +385,7 @@ export class LanguageModelPredictionModule extends LitModule { static findTargetFields(outputSpec: Spec): string[] { const candidates = findSpecKeys(outputSpec, 'TokenTopKPreds'); return candidates.filter(k => { - const align = outputSpec[k].align; + const align = (outputSpec[k] as TokenTopKPreds).align; return align != null && isLitSubtype(outputSpec[align], 'Tokens'); }); } diff --git a/lit_nlp/client/modules/multilabel_module.ts b/lit_nlp/client/modules/multilabel_module.ts index 47257952..5b9dd60b 100644 --- a/lit_nlp/client/modules/multilabel_module.ts +++ b/lit_nlp/client/modules/multilabel_module.ts @@ -24,6 +24,7 @@ import {observable} from 'mobx'; import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; import {SortableTemplateResult, TableData, TableEntry} from '../elements/table'; +import {SparseMultilabelPreds} from '../lib/lit_types'; import {formatBoolean, IndexedInput, ModelInfoMap, NumericResults, Spec} from '../lib/types'; import {doesOutputSpecContain, findSpecKeys} from '../lib/utils'; import {SelectionService} from '../services/services'; @@ -113,7 +114,8 @@ export class MultilabelModule extends LitModule { const outputSpec = this.appState.currentModelSpecs[model].spec.output; const predKeys = findSpecKeys(outputSpec, 'SparseMultilabelPreds'); for (const predKey of predKeys) { - const labelField = outputSpec[predKey].parent; + const labelField = + (outputSpec[predKey] as SparseMultilabelPreds).parent; if (labelField != null) { this.groundTruthLabels.add(labelField); } diff --git a/lit_nlp/client/modules/pdp_module.ts b/lit_nlp/client/modules/pdp_module.ts index 13fed6fe..2f93cf78 100644 --- a/lit_nlp/client/modules/pdp_module.ts +++ b/lit_nlp/client/modules/pdp_module.ts @@ -24,6 +24,7 @@ import {until} from 'lit/directives/until'; import {observable} from 'mobx'; import {LitModule} from '../core/lit_module'; import {ExpansionToggle} from '../elements/expansion_panel'; +import {LitTypeWithNullIdx, LitTypeWithVocab, MulticlassPreds} from '../lib/lit_types'; import {ModelInfoMap, Spec} from '../lib/types'; import {doesInputSpecContain, doesOutputSpecContain, findSpecKeys, isLitSubtype, setEquals} from '../lib/utils'; @@ -159,10 +160,10 @@ export class PdpModule extends LitModule { } } - const nullIdx = spec.output[predKey].null_idx; - const vocab = spec.output[predKey].vocab; - const isClassification = isLitSubtype( - spec.output[predKey], 'MulticlassPreds'); + const {vocab} = spec.output[predKey] as LitTypeWithVocab; + const {null_idx: nullIdx} = spec.output[predKey] as LitTypeWithNullIdx; + + const isClassification = spec.output[predKey] instanceof MulticlassPreds; const yRange = isClassification ? [0, 1] : []; const renderChart = (chartData: ChartInfo) => { if (isNumeric) { diff --git a/lit_nlp/client/modules/regression_module.ts b/lit_nlp/client/modules/regression_module.ts index b8da65a8..3207c300 100644 --- a/lit_nlp/client/modules/regression_module.ts +++ b/lit_nlp/client/modules/regression_module.ts @@ -24,6 +24,7 @@ import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; import {TableData} from '../elements/table'; import {styles as sharedStyles} from '../lib/shared_styles.css'; +import {RegressionScore} from '../lib/lit_types'; import {IndexedInput, ModelInfoMap, RegressionResults, Spec} from '../lib/types'; import {doesOutputSpecContain, findSpecKeys} from '../lib/utils'; import {CalculatedColumnType} from '../services/data_service'; @@ -100,7 +101,8 @@ export class RegressionModule extends LitModule { // Add new row for each output from the model. const score = result[scoreField]?.score?.toFixed(4) || ''; // Target score to compare against. - const parentField = spec.output[scoreField].parent! || ''; + const parentField = + (spec.output[scoreField] as RegressionScore).parent || ''; const parentScore = input.data[parentField]?.toFixed(4) || ''; let errorScore = ''; if (parentField && parentScore) { diff --git a/lit_nlp/client/modules/salience_clustering_module.ts b/lit_nlp/client/modules/salience_clustering_module.ts index fdf3ec82..67c2c97e 100644 --- a/lit_nlp/client/modules/salience_clustering_module.ts +++ b/lit_nlp/client/modules/salience_clustering_module.ts @@ -27,10 +27,11 @@ import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; import {InterpreterClick} from '../elements/interpreter_controls'; import {SortableTemplateResult, TableData} from '../elements/table'; +import {FieldMatcher, LitTypeOfFieldMatcher, MultiFieldMatcher} from '../lib/lit_types'; import {createLitType} from '../lib/lit_types_utils'; import {styles as sharedStyles} from '../lib/shared_styles.css'; import {CallConfig, IndexedInput, Input, ModelInfoMap, Spec} from '../lib/types'; -import {findSpecKeys, isLitSubtype} from '../lib/utils'; +import {findSpecKeys} from '../lib/utils'; import {ColumnData} from '../services/data_service'; import {DataService} from '../services/services'; @@ -386,14 +387,14 @@ export class SalienceClusteringModule extends LitModule { const renderInterpreterControls = (name: string) => { const spec = this.appState.metadata.interpreters[name].configSpec; const clonedSpec = JSON.parse(JSON.stringify(spec)) as Spec; - for (const fieldName of Object.keys(clonedSpec)) { + for (const fieldSpec of Object.values(clonedSpec)) { // If the generator uses a field matcher, then get the matching // field names from the specified spec and use them as the vocab. - if (isLitSubtype(clonedSpec[fieldName], - ['FieldMatcher', 'MultiFieldMatcher'])) { - clonedSpec[fieldName].vocab = - this.appState.getSpecKeysFromFieldMatcher( - clonedSpec[fieldName], this.model); + if (fieldSpec instanceof FieldMatcher || + fieldSpec instanceof MultiFieldMatcher) { + const fieldMatcher = fieldSpec as LitTypeOfFieldMatcher; + fieldMatcher.vocab = this.appState.getSpecKeysFromFieldMatcher( + fieldMatcher, this.model); } } if (Object.keys(clonedSpec).length === 0) { diff --git a/lit_nlp/client/modules/salience_map_module.ts b/lit_nlp/client/modules/salience_map_module.ts index 8f0d2ddb..053e1960 100644 --- a/lit_nlp/client/modules/salience_map_module.ts +++ b/lit_nlp/client/modules/salience_map_module.ts @@ -32,7 +32,8 @@ import {observable} from 'mobx'; import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; import {SalienceCmap, SignedSalienceCmap, UnsignedSalienceCmap} from '../services/color_service'; -import {CallConfig, LitName, ModelInfoMap, SCROLL_SYNC_CSS_CLASS, Spec} from '../lib/types'; +import {FieldMatcher, LitName, LitTypeOfFieldMatcher, MultiFieldMatcher, Salience} from '../lib/lit_types'; +import {CallConfig, ModelInfoMap, SCROLL_SYNC_CSS_CLASS, Spec} from '../lib/types'; import {findSpecKeys, isLitSubtype} from '../lib/utils'; import {FocusData, FocusService} from '../services/focus_service'; import {AppState} from '../services/services'; @@ -122,7 +123,8 @@ export class SalienceMapModule extends LitModule { if (salienceKeys.length === 0) { continue; } - const salienceSpecInfo = interpreters[key].metaSpec[salienceKeys[0]]; + const salienceSpecInfo = + interpreters[key].metaSpec[salienceKeys[0]] as Salience; state[key] = { autorun: !!salienceSpecInfo.autorun, isLoading: false, @@ -364,14 +366,14 @@ export class SalienceMapModule extends LitModule { const renderMethodControls = (name: string) => { const spec = this.appState.metadata.interpreters[name].configSpec; const clonedSpec = JSON.parse(JSON.stringify(spec)) as Spec; - for (const fieldName of Object.keys(clonedSpec)) { + for (const fieldSpec of Object.values(clonedSpec)) { // If the generator uses a field matcher, then get the matching // field names from the specified spec and use them as the vocab. - if (isLitSubtype(clonedSpec[fieldName], - ['FieldMatcher', 'MultiFieldMatcher'])) { - clonedSpec[fieldName].vocab = - this.appState.getSpecKeysFromFieldMatcher( - clonedSpec[fieldName], this.model); + if (fieldSpec instanceof FieldMatcher || + fieldSpec instanceof MultiFieldMatcher) { + const fieldMatcher = fieldSpec as LitTypeOfFieldMatcher; + fieldMatcher.vocab = + this.appState.getSpecKeysFromFieldMatcher(fieldMatcher, this.model); } } return html` diff --git a/lit_nlp/client/modules/scalar_module.ts b/lit_nlp/client/modules/scalar_module.ts index f9021440..017a9516 100644 --- a/lit_nlp/client/modules/scalar_module.ts +++ b/lit_nlp/client/modules/scalar_module.ts @@ -30,6 +30,7 @@ import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; import {LegendType} from '../elements/color_legend'; import {ThresholdChange} from '../elements/threshold_slider'; +import {MulticlassPreds, Scalar} from '../lib/lit_types'; import {styles as sharedStyles} from '../lib/shared_styles.css'; import {D3Selection, formatForDisplay, IndexedInput, ModelInfoMap, ModelSpec} from '../lib/types'; import {doesOutputSpecContain, findSpecKeys, getThresholdFromMargin, isLitSubtype} from '../lib/utils'; @@ -425,8 +426,8 @@ export class ScalarModule extends LitModule { label: string): number | undefined { // If for a multiclass prediction and the DataService has loaded the // classification results, return the label score from the array. - if (isLitSubtype(spec.output[key], 'MulticlassPreds')) { - const {vocab} = spec.output[key]; + if (spec.output[key] instanceof MulticlassPreds) { + const {vocab} = spec.output[key] as MulticlassPreds; const index = vocab!.indexOf(label); const classPreds = preds.data[key]; if (Array.isArray(classPreds)) return classPreds[index]; @@ -453,8 +454,11 @@ export class ScalarModule extends LitModule { // Don't render the threshold for regression or multiclass models. const {output} = this.appState.getModelSpec(this.model); - const {vocab} = output[key]; - if (isLitSubtype(output[key], 'Scalar') || vocab?.length !== 2) continue; + + if (output[key] instanceof Scalar || + (output[key] as MulticlassPreds).vocab?.length !== 2) { + continue; + } // If there is no margin set for the entire dataset (empty string) facet // name, then do not draw a threshold on the plot. @@ -769,7 +773,7 @@ export class ScalarModule extends LitModule { renderClassificationGroup(key: string) { const spec = this.appState.getModelSpec(this.model); - const {vocab, null_idx} = spec.output[key]; + const {vocab, null_idx} = spec.output[key] as MulticlassPreds; if (vocab == null) return; // In the binary classification case, only render one plot that diff --git a/lit_nlp/client/modules/sequence_salience_module.ts b/lit_nlp/client/modules/sequence_salience_module.ts index d50509ef..ef66cb81 100644 --- a/lit_nlp/client/modules/sequence_salience_module.ts +++ b/lit_nlp/client/modules/sequence_salience_module.ts @@ -13,6 +13,7 @@ import {computed, observable} from 'mobx'; import {LitModule} from '../core/lit_module'; import {canonicalizeGenerationResults, GeneratedTextResult, GENERATION_TYPES, getAllOutputTexts, getAllReferenceTexts} from '../lib/generated_text_utils'; +import {Salience} from '../lib/lit_types'; import {styles as sharedStyles} from '../lib/shared_styles.css'; import {IndexedInput, ModelInfoMap, Spec} from '../lib/types'; import {sumArray} from '../lib/utils'; @@ -82,7 +83,8 @@ export class SequenceSalienceModule extends LitModule { @computed get cmap() { if (this.selectedSalienceField != null && - this.salienceSpecInfo[this.selectedSalienceField]?.signed) { + (this.salienceSpecInfo[this.selectedSalienceField] as Salience) + .signed) { return new SignedSalienceCmap(/* gamma */ this.cmapGamma); } else { return new UnsignedSalienceCmap(/* gamma */ this.cmapGamma); diff --git a/lit_nlp/client/modules/span_graph_module.ts b/lit_nlp/client/modules/span_graph_module.ts index f2c4ab2d..fdcc38e0 100644 --- a/lit_nlp/client/modules/span_graph_module.ts +++ b/lit_nlp/client/modules/span_graph_module.ts @@ -26,12 +26,12 @@ import '../elements/span_graph_vis_vertical'; import {customElement} from 'lit/decorators'; import {css, html} from 'lit'; -import {classMap} from 'lit/directives/class-map'; import {computed, observable} from 'mobx'; import {LitModule} from '../core/lit_module'; import {AnnotationLayer, SpanGraph} from '../elements/span_graph_vis_vertical'; -import {EdgeLabel, IndexedInput, Input, LitName, ModelInfoMap, Preds, SpanLabel, Spec} from '../lib/types'; +import {LitName, LitTypeWithAlign} from '../lib/lit_types'; +import {EdgeLabel, IndexedInput, Input, ModelInfoMap, Preds, SpanLabel, Spec} from '../lib/types'; import {findSpecKeys, isLitSubtype} from '../lib/utils'; import {styles as sharedStyles} from '../lib/shared_styles.css'; @@ -87,9 +87,9 @@ function mapTokenToTags(spec: Spec): FieldNameMultimap { const tokenKeys = findSpecKeys(spec, 'Tokens'); // Make a mapping of token keys to one or more tag sets - const tokenToTags = {} as FieldNameMultimap; + const tokenToTags: FieldNameMultimap = {}; for (const tagKey of tagKeys) { - const tokenKey = spec[tagKey].align as string; + const {align: tokenKey} = spec[tagKey] as LitTypeWithAlign; if (!tokenKeys.includes(tokenKey)) { continue; } diff --git a/lit_nlp/client/modules/tcav_module.ts b/lit_nlp/client/modules/tcav_module.ts index ed6772a6..5b73366b 100644 --- a/lit_nlp/client/modules/tcav_module.ts +++ b/lit_nlp/client/modules/tcav_module.ts @@ -28,6 +28,7 @@ import {computed, observable} from 'mobx'; import {app} from '../core/app'; import {LitModule} from '../core/lit_module'; import {TableData} from '../elements/table'; +import {MulticlassPreds} from '../lib/lit_types'; import {createLitType} from '../lib/lit_types_utils'; import {styles as sharedStyles} from '../lib/shared_styles.css'; import {CallConfig, IndexedInput, ModelInfoMap, Spec} from '../lib/types'; @@ -142,14 +143,14 @@ export class TCAVModule extends LitModule { get predClasses() { const predKeys = findSpecKeys(this.modelSpec.output, 'MulticlassPreds'); // TODO(lit-dev): Handle the multi-headed case with more than one pred key. - return this.modelSpec.output[predKeys[0]].vocab!; + return (this.modelSpec.output[predKeys[0]] as MulticlassPreds).vocab; } @computed get nullIndex() { const predKeys = findSpecKeys(this.modelSpec.output, 'MulticlassPreds'); // TODO(lit-dev): Handle the multi-headed case with more than one pred key. - return this.modelSpec.output[predKeys[0]].null_idx!; + return (this.modelSpec.output[predKeys[0]] as MulticlassPreds).null_idx; } override firstUpdated() { diff --git a/lit_nlp/client/modules/tda_module.ts b/lit_nlp/client/modules/tda_module.ts index a760e3de..d50b6636 100644 --- a/lit_nlp/client/modules/tda_module.ts +++ b/lit_nlp/client/modules/tda_module.ts @@ -29,8 +29,9 @@ import {LitModule} from '../core/lit_module'; import {TableData, TableEntry} from '../elements/table'; import {canonicalizeGenerationResults, GeneratedTextResult, GENERATION_TYPES, getAllOutputTexts, getFlatTexts} from '../lib/generated_text_utils'; import {styles as sharedStyles} from '../lib/shared_styles.css'; +import {FieldMatcher, LitTypeOfFieldMatcher, LitTypeWithParent, MultiFieldMatcher} from '../lib/lit_types'; import {CallConfig, ComponentInfoMap, IndexedInput, Input, ModelInfoMap, Spec} from '../lib/types'; -import {filterToKeys, findSpecKeys, isLitSubtype} from '../lib/utils'; +import {filterToKeys, findSpecKeys} from '../lib/utils'; import {AppState, SelectionService} from '../services/services'; import {styles} from './tda_module.css'; @@ -140,9 +141,11 @@ export class TrainingDataAttributionModule extends LitModule { @computed get targetLabelInputKeys(): string[] { const spec = this.appState.getModelSpec(this.model); - const referencedKeys = new Set(Object.values(spec.output) - .filter(v => v.parent != null) - .map(v => v.parent!)); + const referencedKeys = + new Set(Object.values(spec.output) + // tslint:disable-next-line:no-any + .filter(v => (v as any).parent != null) + .map(v => (v as LitTypeWithParent).parent)); return [...referencedKeys].filter(k => spec.input[k] !== undefined); } @@ -169,8 +172,9 @@ export class TrainingDataAttributionModule extends LitModule { // Filter the output spec to only fields that reference this inputKey. const outputSpec = this.appState.getModelSpec(this.model).output; const selectedOutputKeys = - Object.keys(outputSpec) - .filter(k => outputSpec[k].parent === inputKey); + Object + .keys(outputSpec) + .filter(k => (outputSpec[k] as LitTypeWithParent).parent === inputKey); const filteredOutputSpec = filterToKeys(outputSpec, selectedOutputKeys); ret.push(...getAllOutputTexts(filteredOutputSpec, this.currentPreds)); } @@ -529,14 +533,14 @@ export class TrainingDataAttributionModule extends LitModule { const spec = generatorsInfo[genName].configSpec; const clonedSpec = JSON.parse(JSON.stringify(spec)) as Spec; const description = generatorsInfo[genName].description; - for (const fieldName of Object.keys(clonedSpec)) { + for (const fieldSpec of Object.values(clonedSpec)) { // If the generator uses a field matcher, then get the matching // field names from the specified spec and use them as the vocab. - if (isLitSubtype( - clonedSpec[fieldName], ['FieldMatcher', 'MultiFieldMatcher'])) { - clonedSpec[fieldName].vocab = - this.appState.getSpecKeysFromFieldMatcher( - clonedSpec[fieldName], this.model); + if (fieldSpec instanceof FieldMatcher || + fieldSpec instanceof MultiFieldMatcher) { + const fieldMatcher = fieldSpec as LitTypeOfFieldMatcher; + fieldMatcher.vocab = + this.appState.getSpecKeysFromFieldMatcher(fieldMatcher, this.model); } } const runDisabled = diff --git a/lit_nlp/client/services/api_service.ts b/lit_nlp/client/services/api_service.ts index 9317d413..e4e7555b 100644 --- a/lit_nlp/client/services/api_service.ts +++ b/lit_nlp/client/services/api_service.ts @@ -15,6 +15,7 @@ * limitations under the License. */ +import {deserializeLitTypesInLitMetadata} from '../lib/lit_types_utils'; import {CallConfig, IndexedInput, LitMetadata, Preds} from '../lib/types'; import {LitService} from './lit_service'; @@ -84,7 +85,8 @@ export class ApiService extends LitService { */ async getInfo(): Promise { const loadMessage = 'Loading metadata'; - return this.queryServer('/get_info', {}, [], loadMessage); + return this.queryServer('/get_info', {}, [], loadMessage) + .then((metadata) => deserializeLitTypesInLitMetadata(metadata)); } /** @@ -257,4 +259,3 @@ export class ApiService extends LitService { } } } - diff --git a/lit_nlp/client/services/classification_service.ts b/lit_nlp/client/services/classification_service.ts index 7a91643e..513fa344 100644 --- a/lit_nlp/client/services/classification_service.ts +++ b/lit_nlp/client/services/classification_service.ts @@ -18,8 +18,8 @@ // tslint:disable:no-new-decorators import {action, computed, observable, reaction} from 'mobx'; +import {MulticlassPreds} from '../lib/lit_types'; import {FacetedData, GroupedExamples, Spec} from '../lib/types'; -import {isLitSubtype} from '../lib/utils'; import {LitService} from './lit_service'; import {AppState} from './state_service'; @@ -120,11 +120,12 @@ export class ClassificationService extends LitService { for (const [model, output] of Object.entries(modelOutputSpecMap)) { marginSettings[model] = {}; for (const [fieldName, fieldSpec] of Object.entries(output)) { - if (isLitSubtype(fieldSpec, 'MulticlassPreds') && + if (fieldSpec instanceof MulticlassPreds && fieldSpec.null_idx != null && fieldSpec.vocab != null) { marginSettings[model][fieldName] = {}; - if (this.marginSettings[model][fieldName] != null) { + if (model in this.marginSettings && + this.marginSettings[model][fieldName] != null) { // Reset all facets to margin = 0. const facets = Object.keys(this.marginSettings[model][fieldName]); for (const key of facets) { diff --git a/lit_nlp/client/services/data_service.ts b/lit_nlp/client/services/data_service.ts index d3e64a01..9f5e58ab 100644 --- a/lit_nlp/client/services/data_service.ts +++ b/lit_nlp/client/services/data_service.ts @@ -19,8 +19,9 @@ import {action, computed, observable, reaction} from 'mobx'; import {BINARY_NEG_POS, ColorRange} from '../lib/colors'; +import {LitName, LitType, MulticlassPreds, RegressionScore} from '../lib/lit_types'; import {createLitType} from '../lib/lit_types_utils'; -import {ClassificationResults, IndexedInput, LitName, LitType, RegressionResults} from '../lib/types'; +import {ClassificationResults, IndexedInput, RegressionResults} from '../lib/types'; import {findSpecKeys, isLitSubtype, mapsContainSame} from '../lib/utils'; import {LitService} from './lit_service'; @@ -170,14 +171,17 @@ export class DataService extends LitService { scores, data, key, scoreFeatName, createLitType('MulticlassPreds'), source); const litTypeClassification = createLitType('CategoryLabel'); - litTypeClassification.vocab = output[key].vocab; - this.addColumnFromList( - predClasses, data, key, predClassFeatName, litTypeClassification, - source); - if (output[key].parent != null) { + if (output[key] instanceof MulticlassPreds) { + const predSpec = output[key] as MulticlassPreds; + litTypeClassification.vocab = predSpec.vocab; this.addColumnFromList( - correctness, data, key, correctnessName, createLitType('Boolean'), - source, () => null, BINARY_NEG_POS); + predClasses, data, key, predClassFeatName, litTypeClassification, + source); + if (predSpec.parent != null) { + this.addColumnFromList( + correctness, data, key, correctnessName, createLitType('Boolean'), + source, () => null, BINARY_NEG_POS); + } } } } @@ -218,11 +222,14 @@ export class DataService extends LitService { const source = `${REGRESSION_SOURCE_PREFIX}:${model}`; this.addColumnFromList( scores, data, key, scoreFeatName, dataType, source); - if (output[key].parent != null) { - this.addColumnFromList( - errors, data, key, errorFeatName, dataType, source); - this.addColumnFromList( - sqErrors, data, key, sqErrorFeatName, dataType, source); + if (output[key] instanceof RegressionScore) { + const predSpec = output[key] as RegressionScore; + if (predSpec.parent != null) { + this.addColumnFromList( + errors, data, key, errorFeatName, dataType, source); + this.addColumnFromList( + sqErrors, data, key, sqErrorFeatName, dataType, source); + } } } } diff --git a/lit_nlp/client/services/group_service.ts b/lit_nlp/client/services/group_service.ts index 58bde84f..052f279c 100644 --- a/lit_nlp/client/services/group_service.ts +++ b/lit_nlp/client/services/group_service.ts @@ -24,6 +24,7 @@ import * as d3 from 'd3'; // Used for creating bins, not visualization. import {computed, reaction} from 'mobx'; +import {CategoryLabel, LitTypeWithVocab} from '../lib/lit_types'; import {FacetMap, GroupedExamples, IndexedInput} from '../lib/types'; import {facetMapToDictKey, findSpecKeys, getStepSizeGivenRange, roundToDecimalPlaces} from '../lib/utils'; @@ -168,7 +169,8 @@ export class GroupService extends LitService { const categoricalFeatures: CategoricalFeatures = {}; for (const name of this.categoricalFeatureNames) { // Try to get values from the data spec. - const vocab = this.appState.currentDatasetSpec[name]?.vocab; + const vocab = + (this.appState.currentDatasetSpec[name] as LitTypeWithVocab)?.vocab; if (vocab != null) { categoricalFeatures[name] = [...vocab]; @@ -178,9 +180,9 @@ export class GroupService extends LitService { // Try to get values from the data service. Either from the // CategoryLabel's vocab... const columnHeader = this.dataService.getColumnInfo(name); - - if (columnHeader?.dataType.vocab != null) { - categoricalFeatures[name] = columnHeader.dataType.vocab; + const categoryLabel = columnHeader?.dataType as CategoryLabel; + if (categoryLabel != null && categoryLabel.vocab != null) { + categoricalFeatures[name] = categoryLabel.vocab; continue; } // ... Or as a last resort find unique values from the data. diff --git a/lit_nlp/client/services/state_service.ts b/lit_nlp/client/services/state_service.ts index 924f453a..862c12d8 100644 --- a/lit_nlp/client/services/state_service.ts +++ b/lit_nlp/client/services/state_service.ts @@ -18,7 +18,9 @@ // tslint:disable:no-new-decorators import {action, computed, observable, toJS} from 'mobx'; -import {canonicalizeLayout, IndexedInput, LitCanonicalLayout, LitComponentLayouts, LitMetadata, LitType, ModelInfo, ModelInfoMap, ModelSpec, Spec} from '../lib/types'; +import {LitType, LitTypeOfFieldMatcher} from '../lib/lit_types'; +import {canonicalizeLayout, IndexedInput, LitCanonicalLayout, LitComponentLayouts, LitMetadata, ModelInfo, ModelInfoMap, ModelSpec, Spec} from '../lib/types'; +import {createLitType as createLitTypeUtil} from '../lib/lit_types_utils'; import {findSpecKeys} from '../lib/utils'; import {ApiService} from './api_service'; @@ -102,15 +104,9 @@ export class AppState extends LitService implements StateObservedByUrlService { return findSpecKeys(this.currentDatasetSpec, 'ImageBytes').length > 0; } + // TODO(b/162269499): Call from utilities directly. createLitType(typeName: string, showInDataTable = true): LitType { - const litType = this.metadata.littypes[typeName]; - if (litType == null) { - throw new Error(`LitType ${typeName} not defined`); - } - const newType = {...litType}; - newType['__class__'] = 'LitType'; - newType['show_in_data_table'] = showInDataTable; - return newType; + return createLitTypeUtil(typeName, {"show_in_data_table": showInDataTable}); } @observable @@ -243,14 +239,14 @@ export class AppState extends LitService implements StateObservedByUrlService { /** * Get the spec keys matching the info from the provided FieldMatcher. */ - getSpecKeysFromFieldMatcher(matcher: LitType, modelName: string) { + getSpecKeysFromFieldMatcher(matcher: LitTypeOfFieldMatcher, modelName: string) { let spec = this.currentDatasetSpec; if (matcher.spec === 'output') { spec = this.currentModelSpecs[modelName].spec.output; } else if (matcher.spec === 'input') { spec = this.currentModelSpecs[modelName].spec.input; } - return findSpecKeys(spec, matcher.types!); + return findSpecKeys(spec, matcher.types); } //=================================== Generation logic