Welcome to Kazu’s documentation!

Guides and Tutorials

• Introduction
  • Why Kazu?
  • Summary
• Quickstart
  • Installation
  • Model Pack
  • Default configuration
  • Processing your first document
  • Using Kazu in a notebook or other non-Hydra application
  • Running Steps
• The Default Kazu Pipeline
• Kazu Data Model
  • Data Serialization and deserialization
• Visualising results in Label Studio
• The OntologyParser
  • Writing a Custom Parser
  • Using “OntologyStringResource” for dictionary based matching and/or to modify an Ontology’s behaviour
• The Kazu Resource Tool
• Curating a knowledge base for NER and Linking
• Scaling with Ray
• Kazu as a WebService
• Using Kazu as a library
  • Dependency conflicts
• Development Setup
  • Installing Dependencies
  • Git-lfs (Large File Storage) Setup
  • Pre Commits
  • Updating the Changelog
• Changelog
  • 2.2.1 - 2024-10-21
  • 2.2.0 - 2024-09-18
  • 2.1.1 - 2024-07-08
  • 2.1.0 - 2024-07-04
  • 2.0.0 - 2024-06-04
  • 1.5.1 - 2024-01-29
  • 1.5.0 - 2024-01-19
  • 1.4.0 - 2023-12-01
  • 1.3.2 - 2023-11-21
  • 1.3.1 - 2023-11-15
  • 1.3.0 - 2023-11-07
  • 1.2.0 - 2023-10-18
  • 1.1.2 - 2023-10-11
  • 1.1.1 - 2023-10-10
  • 1.1.0 - 2023-10-10
  • 1.0.3 - 2023-08-15
  • 1.0.2 - 2023-08-07
  • 1.0.1 - 2023-07-31
  • 1.0.0 - 2023-07-21
  • 0.1.0 - 2023-03-29
  • 0.0.25 - 2023-02-28

API Documentation

• kazu
  • kazu.annotation
    • kazu.annotation.acceptance_test
    • kazu.annotation.label_studio
  • kazu.data
  • kazu.database
    • kazu.database.in_memory_db
  • kazu.krt
    • kazu.krt.components
    • kazu.krt.ontology_update_editor
      • kazu.krt.ontology_update_editor.components
      • kazu.krt.ontology_update_editor.utils
    • kazu.krt.resource_discrepancy_editor
      • kazu.krt.resource_discrepancy_editor.components
      • kazu.krt.resource_discrepancy_editor.utils
    • kazu.krt.resource_manager
    • kazu.krt.string_editor
      • kazu.krt.string_editor.components
      • kazu.krt.string_editor.utils
    • kazu.krt.utils
  • kazu.language
    • kazu.language.language_phenomena
    • kazu.language.string_similarity_scorers
  • kazu.ontology_matching
    • kazu.ontology_matching.assemble_pipeline
    • kazu.ontology_matching.ontology_matcher
  • kazu.ontology_preprocessing
    • kazu.ontology_preprocessing.autocuration
    • kazu.ontology_preprocessing.base
    • kazu.ontology_preprocessing.constants
    • kazu.ontology_preprocessing.curation_utils
    • kazu.ontology_preprocessing.downloads
    • kazu.ontology_preprocessing.ontology_upgrade_report
    • kazu.ontology_preprocessing.parsers
    • kazu.ontology_preprocessing.synonym_generation
  • kazu.pipeline
  • kazu.steps
    • kazu.steps.document_post_processing
      • kazu.steps.document_post_processing.abbreviation_finder
    • kazu.steps.joint_ner_and_linking
      • kazu.steps.joint_ner_and_linking.explosion
      • kazu.steps.joint_ner_and_linking.memory_efficient_string_matching
    • kazu.steps.linking
      • kazu.steps.linking.dictionary
      • kazu.steps.linking.entity_class_disambiguation
      • kazu.steps.linking.post_processing
        • kazu.steps.linking.post_processing.disambiguation
          • kazu.steps.linking.post_processing.disambiguation.context_scoring
          • kazu.steps.linking.post_processing.disambiguation.strategies
        • kazu.steps.linking.post_processing.mapping_step
        • kazu.steps.linking.post_processing.mapping_strategies
          • kazu.steps.linking.post_processing.mapping_strategies.strategies
        • kazu.steps.linking.post_processing.strategy_runner
        • kazu.steps.linking.post_processing.xref_manager
      • kazu.steps.linking.rules_based_disambiguation
    • kazu.steps.ner
      • kazu.steps.ner.entity_post_processing
      • kazu.steps.ner.gliner
      • kazu.steps.ner.hf_token_classification
      • kazu.steps.ner.llm_ner
      • kazu.steps.ner.opsin
      • kazu.steps.ner.seth
      • kazu.steps.ner.spacy_ner
      • kazu.steps.ner.tokenized_word_processor
    • kazu.steps.other
      • kazu.steps.other.cleanup
      • kazu.steps.other.merge_overlapping_ents
      • kazu.steps.other.stanza
    • kazu.steps.step
  • kazu.utils
    • kazu.utils.abbreviation_detector
    • kazu.utils.build_and_test_model_packs
    • kazu.utils.caching
    • kazu.utils.constants
    • kazu.utils.download_gilda_contexts
    • kazu.utils.grouping
    • kazu.utils.link_index
    • kazu.utils.sapbert
    • kazu.utils.spacy_object_mapper
    • kazu.utils.spacy_pipeline
    • kazu.utils.stanza_pipeline
    • kazu.utils.string_normalizer
    • kazu.utils.utils
  • kazu.web
    • kazu.web.jwtauth
    • kazu.web.ls_web_utils
    • kazu.web.req_id_header
    • kazu.web.routes
    • kazu.web.server

Site Index

• Index
• Module Index