📖 References

Reference documents for the hinteval package.

• Dataset
  • Dataset
    • Dataset.name
    • Dataset.url
    • Dataset.version
    • Dataset.description
    • Dataset.metadata
    • Dataset.add_subset()
    • Dataset.available_datasets()
    • Dataset.download_and_load_dataset()
    • Dataset.get_subset()
    • Dataset.get_subsets()
    • Dataset.get_subsets_name()
    • Dataset.load()
    • Dataset.load_json()
    • Dataset.prepare_dataset()
    • Dataset.remove_subset()
    • Dataset.store()
    • Dataset.store_json()
    • Dataset.to_dict()
  • Answer
    • Answer.answer
    • Answer.entities
    • Answer.metrics
    • Answer.metadata
    • Answer.from_dict()
    • Answer.to_dict()
  • Entity
    • Entity.entity
    • Entity.ent_type
    • Entity.start_index
    • Entity.end_index
    • Entity.metadata
    • Entity.from_dict()
    • Entity.to_dict()
  • Hint
    • Hint.hint
    • Hint.source
    • Hint.entities
    • Hint.metrics
    • Hint.metadata
    • Hint.from_dict()
    • Hint.to_dict()
  • Instance
    • Instance.question
    • Instance.answers
    • Instance.hints
    • Instance.metadata
    • Instance.answers_from_strings()
    • Instance.from_dict()
    • Instance.from_strings()
    • Instance.hints_from_strings()
    • Instance.question_from_string()
    • Instance.to_dict()
  • Metric
    • Metric.name
    • Metric.value
    • Metric.metadata
    • Metric.from_dict()
    • Metric.to_dict()
  • NotComparableException
  • Question
    • Question.question
    • Question.question_type
    • Question.entities
    • Question.metrics
    • Question.metadata
    • Question.from_dict()
    • Question.to_dict()
  • Subset
    • Subset.name
    • Subset.metadata
    • Subset.add_instance()
    • Subset.from_dict()
    • Subset.get_instance()
    • Subset.get_instance_ids()
    • Subset.get_instances()
    • Subset.remove_instance()
    • Subset.to_dict()
• Metrics
  • Relevance
  • Readability
    • TraditionalIndexes
      • TraditionalIndexes.spacy_pipeline
      • TraditionalIndexes.checkpoint
      • TraditionalIndexes.checkpoint_step
      • TraditionalIndexes.enable_tqdm
      • TraditionalIndexes.evaluate()
      • TraditionalIndexes.release_memory()
    • MachineLearningBased
      • MachineLearningBased.checkpoint
      • MachineLearningBased.checkpoint_step
      • MachineLearningBased.enable_tqdm
      • MachineLearningBased.evaluate()
      • MachineLearningBased.release_memory()
    • NeuralNetworkBased
      • NeuralNetworkBased.checkpoint
      • NeuralNetworkBased.checkpoint_step
      • NeuralNetworkBased.enable_tqdm
      • NeuralNetworkBased.evaluate()
      • NeuralNetworkBased.release_memory()
    • LlmBased
      • LlmBased.checkpoint
      • LlmBased.checkpoint_step
      • LlmBased.enable_tqdm
      • LlmBased.evaluate()
      • LlmBased.release_memory()
  • Convergence
    • Specificity
      • Specificity.checkpoint
      • Specificity.checkpoint_step
      • Specificity.enable_tqdm
      • Specificity.evaluate()
      • Specificity.release_memory()
    • NeuralNetworkBased
      • NeuralNetworkBased.checkpoint
      • NeuralNetworkBased.checkpoint_step
      • NeuralNetworkBased.enable_tqdm
      • NeuralNetworkBased.evaluate()
      • NeuralNetworkBased.release_memory()
    • LlmBased
      • LlmBased.checkpoint
      • LlmBased.checkpoint_step
      • LlmBased.enable_tqdm
      • LlmBased.evaluate()
      • LlmBased.release_memory()
  • Familiarity
    • WordFrequency
      • WordFrequency.checkpoint
      • WordFrequency.checkpoint_step
      • WordFrequency.enable_tqdm
      • WordFrequency.evaluate()
      • WordFrequency.release_memory()
    • Wikipedia
      • Wikipedia.checkpoint
      • Wikipedia.checkpoint_step
      • Wikipedia.enable_tqdm
      • Wikipedia.evaluate()
      • Wikipedia.release_memory()
  • Answer Leakage
    • Lexical
      • Lexical.batch_size
      • Lexical.checkpoint
      • Lexical.checkpoint_step
      • Lexical.enable_tqdm
      • Lexical.evaluate()
      • Lexical.release_memory()
    • ContextualEmbeddings
      • ContextualEmbeddings.checkpoint
      • ContextualEmbeddings.checkpoint_step
      • ContextualEmbeddings.enable_tqdm
      • ContextualEmbeddings.evaluate()
      • ContextualEmbeddings.release_memory()
• Model
  • AnswerAware
    • AnswerAware.checkpoint
    • AnswerAware.checkpoint_step
    • AnswerAware.enable_tqdm
    • AnswerAware.generate()
    • AnswerAware.release_memory()
  • AnswerAgnostic
    • AnswerAgnostic.checkpoint
    • AnswerAgnostic.checkpoint_step
    • AnswerAgnostic.enable_tqdm
    • AnswerAgnostic.generate()
    • AnswerAgnostic.release_memory()
• Miscellaneous
  • identify_entities()
  • identify_question_type()