Rename lm_salience_module to sequence_salience_module

PiperOrigin-RevId: 636277468
PAIR-code · bdu91 · Jun 26, 2024 · Apr 19, 2024 · Apr 26, 2024 · Apr 26, 2024
commit b16059fbd0320d411298009c0226489e1f548a69
diff --git a/lit_nlp/api/layout.py b/lit_nlp/api/layout.py
@@ -29,19 +29,15 @@ class LitModuleName(dtypes.EnumSerializableAsValues, enum.Enum):
   Entries should map the TypeScript class name to the HTML element name,
   as declared in HTMLElementTagNameMap in the .ts file defining each LitModule.
   """
-  AnnotatedTextModule = 'annotated-text-module'
+  # keep-sorted start
   AnnotatedTextGoldModule = 'annotated-text-gold-module'
+  AnnotatedTextModule = 'annotated-text-module'
   AttentionModule = 'attention-module'
   ClassificationModule = 'classification-module'
   ConfusionMatrixModule = 'confusion-matrix-module'
   CurvesModule = 'curves-module'
   DataTableModule = 'data-table-module'
-  SimpleDataTableModule = 'simple-data-table-module'
   DatapointEditorModule = 'datapoint-editor-module'
-  # Non-replicating version of Datapoint Editor
-  SingleDatapointEditorModule = 'single-datapoint-editor-module'
-  # Simplified, non-replicating version of Datapoint Editor
-  SimpleDatapointEditorModule = 'simple-datapoint-editor-module'
   DiveModule = 'dive-module'
   DocumentationModule = 'documentation-module'
   EmbeddingsModule = 'embeddings-module'
@@ -50,22 +46,28 @@ class LitModuleName(dtypes.EnumSerializableAsValues, enum.Enum):
   GeneratedTextModule = 'generated-text-module'
   GeneratorModule = 'generator-module'
   LanguageModelPredictionModule = 'lm-prediction-module'
-  LMSalienceModule = 'lm-salience-module'
+  LegacySequenceSalienceModule = 'legacy-sequence-salience-module'
   MetricsModule = 'metrics-module'
   MultilabelModule = 'multilabel-module'
   PdpModule = 'pdp-module'
   RegressionModule = 'regression-module'
   SalienceClusteringModule = 'salience-clustering-module'
   SalienceMapModule = 'salience-map-module'
   ScalarModule = 'scalar-module'
-  LegacySequenceSalienceModule = 'legacy-sequence-salience-module'
+  SequenceSalienceModule = 'sequence-salience-module'
+  SimpleDataTableModule = 'simple-data-table-module'
+  # Simplified, non-replicating version of Datapoint Editor
+  SimpleDatapointEditorModule = 'simple-datapoint-editor-module'
+  # Non-replicating version of Datapoint Editor
+  SingleDatapointEditorModule = 'single-datapoint-editor-module'
   SpanGraphGoldModule = 'span-graph-gold-module'
-  SpanGraphModule = 'span-graph-module'
   SpanGraphGoldModuleVertical = 'span-graph-gold-module-vertical'
+  SpanGraphModule = 'span-graph-module'
   SpanGraphModuleVertical = 'span-graph-module-vertical'
   TCAVModule = 'tcav-module'
-  TrainingDataAttributionModule = 'tda-module'
   ThresholderModule = 'thresholder-module'
+  TrainingDataAttributionModule = 'tda-module'
+  # keep-sorted end
 
   def __call__(self, **kw):
     return ModuleConfig(self.value, **kw)

diff --git a/...nlp/client/modules/lm_salience_module.css → ...ient/modules/sequence_salience_module.css b/...nlp/client/modules/lm_salience_module.css → ...ient/modules/sequence_salience_module.css
diff --git a/lit_nlp/client/modules/lm_salience_module.ts → ...lient/modules/sequence_salience_module.ts b/lit_nlp/client/modules/lm_salience_module.ts → ...lient/modules/sequence_salience_module.ts
@@ -1,5 +1,5 @@
 /**
- * @fileoverview Custom viz module for causal LM salience.
+ * @fileoverview Custom viz module for sequence salience with causal LMs.
  */
 
 import '@material/mwc-icon';
@@ -26,7 +26,7 @@ import {cleanSpmText, groupTokensByRegexPrefix, groupTokensByRegexSeparator} fro
 import {type IndexedInput, type Preds, SCROLL_SYNC_CSS_CLASS, type Spec} from '../lib/types';
 import {cumSumArray, filterToKeys, findSpecKeys, groupAlike, makeModifiedInput, sumArray} from '../lib/utils';
 
-import {styles} from './lm_salience_module.css';
+import {styles} from './sequence_salience_module.css';
 
 /**
  * Max of absolute value
@@ -133,10 +133,10 @@ export class SingleExampleSingleModelModule extends LitModule {
 }
 
 /**
- * Custom styled version of <lit-token-chips> for rendering LM salience tokens.
+ * Custom styles for <lit-token-chips> to render sequence salience tokens.
  */
-@customElement('lm-salience-chips')
-class LMSalienceChips extends TextChips {
+@customElement('sequence-salience-chips')
+class SequenceSalienceChips extends TextChips {
   @property({type: Boolean}) underline = false;
 
   override holderClass() {
@@ -205,8 +205,8 @@ const CMAP_DEFAULT_RANGE = 0.4;
 const DEFAULT_CUSTOM_SEGMENTATION_REGEX = '\\n+';
 
 /** LIT module for model output. */
-@customElement('lm-salience-module')
-export class LMSalienceModule extends SingleExampleSingleModelModule {
+@customElement('sequence-salience-module')
+export class SequenceSalienceModule extends SingleExampleSingleModelModule {
   static override title = 'Sequence Salience';
   static override numCols = 6;  // 60% of screen width if DataTable on left
   static override duplicateAsRow = true;
@@ -215,9 +215,9 @@ export class LMSalienceModule extends SingleExampleSingleModelModule {
       model: string,
       selectionServiceIndex: number,
       shouldReact: number,
-      ) => html`<lm-salience-module model=${model} .shouldReact=${shouldReact}
+      ) => html`<sequence-salience-module model=${model} .shouldReact=${shouldReact}
                   selectionServiceIndex=${selectionServiceIndex}>
-                </lm-salience-module>`;
+                </sequence-salience-module>`;
 
   static override get styles() {
     return [sharedStyles, styles];
@@ -561,7 +561,7 @@ export class LMSalienceModule extends SingleExampleSingleModelModule {
     });
 
     // If selected example OR selected target string change.
-    // NOTE: you may see a console warning: "Element lm-salience-module
+    // NOTE: you may see a console warning: "Element sequence-salience-module
     // scheduled an update (generally because a property was set) after an
     // update completed, causing a new update to be scheduled."
     // This is okay here: this.modifiedData will be updated after
@@ -994,12 +994,12 @@ export class LMSalienceModule extends SingleExampleSingleModelModule {
     // prettier-ignore
     return html`
       <div class='chip-container'>
-        <lm-salience-chips
+        <sequence-salience-chips
           .tokensWithWeights=${segmentsWithWeights} .cmap=${this.cmap}
           ?dense=${this.denseView} ?vDense=${this.vDense}
           ?underline=${this.underline}
           ?preSpace=${this.denseView} breakNewlines>
-        </lm-salience-chips>
+        </sequence-salience-chips>
       </div>
     `;
   }
@@ -1081,7 +1081,7 @@ export class LMSalienceModule extends SingleExampleSingleModelModule {
 
 declare global {
   interface HTMLElementTagNameMap {
-    'lm-salience-chips': LMSalienceChips;
-    'lm-salience-module': LMSalienceModule;
+    'sequence-salience-chips': SequenceSalienceChips;
+    'sequence-salience-module': SequenceSalienceModule;
   }
-}
+}
diff --git a/lit_nlp/examples/lm_salience_demo.py b/lit_nlp/examples/lm_salience_demo.py
@@ -54,7 +54,10 @@
 from lit_nlp import server_flags
 from lit_nlp.api import layout
 from lit_nlp.examples.datasets import lm as lm_data
-from lit_nlp.lib import file_cache
+
+# TODO(b/333698148): file_cache doesn't work well with certain HF and KerasNLP
+# preset names. Disabling until resolved.
+# from lit_nlp.lib import file_cache
 
 # NOTE: additional flags defined in server_flags.py
 
@@ -132,7 +135,7 @@
         "Editor": [modules.SingleDatapointEditorModule],
     },
     upper={  # if 'lower' not specified, this fills the right side
-        "Salience": [modules.LMSalienceModule],
+        "Salience": [modules.SequenceSalienceModule],
     },
     layoutSettings=layout.LayoutSettings(leftWidth=40),
     description="Left/right layout for language model salience.",
@@ -143,7 +146,7 @@
         "Editor": [modules.SimpleDatapointEditorModule],
     },
     lower={
-        "Salience": [modules.LMSalienceModule],
+        "Salience": [modules.SequenceSalienceModule],
     },
     layoutSettings=layout.LayoutSettings(
         hideToolbar=True,
@@ -162,7 +165,7 @@
         "Datapoint Generators": [modules.GeneratorModule],
     },
     lower={
-        "Salience": [modules.LMSalienceModule],
+        "Salience": [modules.SequenceSalienceModule],
         "Metrics": [modules.MetricsModule],
     },
     layoutSettings=layout.LayoutSettings(
@@ -279,10 +282,12 @@ def main(argv: Sequence[str]) -> Optional[dev_server.LitServerType]:
     model_name, path = model_string.split(":", 1)
     logging.info("Loading model '%s' from '%s'", model_name, path)
 
-    path = file_cache.cached_path(
-        path,
-        extract_compressed_file=path.endswith(".tar.gz"),
-    )
+    # TODO(b/333698148): file_cache doesn't work well with certain HF and
+    # KerasNLP preset names. Disabling until resolved.
+    # path = file_cache.cached_path(
+    #     path,
+    #     extract_compressed_file=path.endswith(".tar.gz"),
+    # )
 
     if _DL_FRAMEWORK.value == "kerasnlp":
       # pylint: disable=g-import-not-at-top

diff --git a/requirements_core.txt b/requirements_core.txt
@@ -21,7 +21,7 @@ filelock>=3.12.3
 google-cloud-translate>=3.11.1
 ipython>=7.34.0
 Levenshtein>=0.21.1
-matplotlib>=3.7.1
+matplotlib>=3.6.0,<3.9.0
 ml-collections>=0.1.1
 numpy>=1.24.1
 pandas>=2.0.3