Method save

lit_nlp/api/dataset.py:338–359

Save newly-created datapoints to disk. Args: examples: A list of datapoints to save. path: The path to save the datapoints to. Returns: (string) The file path of the saved datapoints.

(self, examples: list[IndexedInput], path: str)

    return types.MappingProxyType(self._index)

  def save(self, examples: list[IndexedInput], path: str):
    """Save newly-created datapoints to disk.

    Args:
      examples: A list of datapoints to save.
      path: The path to save the datapoints to.

    Returns:
      (string) The file path of the saved datapoints.
    """
    # Attempt to save the datapoints using the base save method, which
    # datasets can override. Then also save in the lit json format and save
    # the spec as well.
    if not path.endswith(LIT_FILE_EXTENSION):
      if (base_dataset := self._base) is not None:
        base_dataset.save(examples, path)
      path += LIT_FILE_EXTENSION

    write_examples(examples, path)
    write_spec(self.spec(), path + LIT_SPEC_EXTENSION)

    return path

  def load(self, path: str):
    """Load and return additional previously-saved datapoints for this dataset.