olaf.pipeline.pipeline_component package

Subpackages

• olaf.pipeline.pipeline_component.axiom_extraction package
  • Submodules
  • olaf.pipeline.pipeline_component.axiom_extraction.llm_based_axiom_extraction module
    • LLMBasedOWLAxiomExtraction
      • LLMBasedOWLAxiomExtraction.check_resources()
      • LLMBasedOWLAxiomExtraction.get_performance_report()
      • LLMBasedOWLAxiomExtraction.optimise()
      • LLMBasedOWLAxiomExtraction.run()
  • olaf.pipeline.pipeline_component.axiom_extraction.owl_axiom_extraction module
    • OWLAxiomExtraction
      • OWLAxiomExtraction.build_full_graph()
      • OWLAxiomExtraction.build_graph_without_owl_instances()
      • OWLAxiomExtraction.check_resources()
      • OWLAxiomExtraction.get_performance_report()
      • OWLAxiomExtraction.optimise()
      • OWLAxiomExtraction.run()
  • Module contents
• olaf.pipeline.pipeline_component.candidate_term_enrichment package
  • Submodules
  • olaf.pipeline.pipeline_component.candidate_term_enrichment.knowledge_based_enrichment module
    • KnowledgeBasedCTermEnrichment
      • KnowledgeBasedCTermEnrichment.check_resources()
      • KnowledgeBasedCTermEnrichment.get_performance_report()
      • KnowledgeBasedCTermEnrichment.optimise()
      • KnowledgeBasedCTermEnrichment.run()
  • olaf.pipeline.pipeline_component.candidate_term_enrichment.llm_based_enrichment module
    • LLMBasedTermEnrichment
      • LLMBasedTermEnrichment.check_resources()
      • LLMBasedTermEnrichment.get_performance_report()
      • LLMBasedTermEnrichment.optimise()
      • LLMBasedTermEnrichment.run()
  • olaf.pipeline.pipeline_component.candidate_term_enrichment.semantic_based_enrichment module
    • SemanticBasedEnrichment
      • SemanticBasedEnrichment.check_resources()
      • SemanticBasedEnrichment.enrich_term()
      • SemanticBasedEnrichment.get_performance_report()
      • SemanticBasedEnrichment.optimise()
      • SemanticBasedEnrichment.run()
  • Module contents
• olaf.pipeline.pipeline_component.concept_relation_extraction package
  • Submodules
  • olaf.pipeline.pipeline_component.concept_relation_extraction.agglomerative_clustering_concept_extraction module
    • AgglomerativeClusteringConceptExtraction
      • AgglomerativeClusteringConceptExtraction.check_resources()
      • AgglomerativeClusteringConceptExtraction.get_performance_report()
      • AgglomerativeClusteringConceptExtraction.optimise()
      • AgglomerativeClusteringConceptExtraction.run()
  • olaf.pipeline.pipeline_component.concept_relation_extraction.agglomerative_clustering_relation_extraction module
    • AgglomerativeClusteringRelationExtraction
      • AgglomerativeClusteringRelationExtraction.check_resources()
      • AgglomerativeClusteringRelationExtraction.get_performance_report()
      • AgglomerativeClusteringRelationExtraction.optimise()
      • AgglomerativeClusteringRelationExtraction.run()
  • olaf.pipeline.pipeline_component.concept_relation_extraction.candidate_terms_to_concepts module
    • CTsToConceptExtraction
      • CTsToConceptExtraction.check_resources()
      • CTsToConceptExtraction.get_performance_report()
      • CTsToConceptExtraction.optimise()
      • CTsToConceptExtraction.run()
  • olaf.pipeline.pipeline_component.concept_relation_extraction.candidate_terms_to_relations module
    • CTsToRelationExtraction
      • CTsToRelationExtraction.check_resources()
      • CTsToRelationExtraction.get_performance_report()
      • CTsToRelationExtraction.optimise()
      • CTsToRelationExtraction.run()
  • olaf.pipeline.pipeline_component.concept_relation_extraction.concept_cooc_metarelation_extraction module
    • ConceptCoocMetarelationExtraction
      • ConceptCoocMetarelationExtraction.check_resources()
      • ConceptCoocMetarelationExtraction.get_performance_report()
      • ConceptCoocMetarelationExtraction.optimise()
      • ConceptCoocMetarelationExtraction.run()
  • olaf.pipeline.pipeline_component.concept_relation_extraction.knowledge_based_concept_extraction module
    • KnowledgeBasedConceptExtraction
      • KnowledgeBasedConceptExtraction.c_terms_texts_to_match()
      • KnowledgeBasedConceptExtraction.check_resources()
      • KnowledgeBasedConceptExtraction.get_performance_report()
      • KnowledgeBasedConceptExtraction.optimise()
      • KnowledgeBasedConceptExtraction.run()
  • olaf.pipeline.pipeline_component.concept_relation_extraction.knowledge_based_relation_extraction module
    • KnowledgeBasedRelationExtraction
      • KnowledgeBasedRelationExtraction.c_terms_texts_to_match()
      • KnowledgeBasedRelationExtraction.check_resources()
      • KnowledgeBasedRelationExtraction.get_performance_report()
      • KnowledgeBasedRelationExtraction.optimise()
      • KnowledgeBasedRelationExtraction.run()
  • olaf.pipeline.pipeline_component.concept_relation_extraction.llm_based_concept_extraction module
    • LLMBasedConceptExtraction
      • LLMBasedConceptExtraction.check_resources()
      • LLMBasedConceptExtraction.get_performance_report()
      • LLMBasedConceptExtraction.optimise()
      • LLMBasedConceptExtraction.run()
  • olaf.pipeline.pipeline_component.concept_relation_extraction.llm_based_relation_extraction module
    • LLMBasedRelationExtraction
      • LLMBasedRelationExtraction.check_resources()
      • LLMBasedRelationExtraction.get_performance_report()
      • LLMBasedRelationExtraction.optimise()
      • LLMBasedRelationExtraction.run()
  • olaf.pipeline.pipeline_component.concept_relation_extraction.synonym_concept_extraction module
    • SynonymConceptExtraction
      • SynonymConceptExtraction.check_resources()
      • SynonymConceptExtraction.get_performance_report()
      • SynonymConceptExtraction.optimise()
      • SynonymConceptExtraction.run()
  • olaf.pipeline.pipeline_component.concept_relation_extraction.synonym_relation_extraction module
    • SynonymRelationExtraction
      • SynonymRelationExtraction.check_resources()
      • SynonymRelationExtraction.get_performance_report()
      • SynonymRelationExtraction.optimise()
      • SynonymRelationExtraction.run()
  • Module contents
• olaf.pipeline.pipeline_component.concept_relation_hierarchy package
  • Submodules
  • olaf.pipeline.pipeline_component.concept_relation_hierarchy.llm_based_hierarchisation module
    • LLMBasedHierarchisation
      • LLMBasedHierarchisation.check_resources()
      • LLMBasedHierarchisation.get_performance_report()
      • LLMBasedHierarchisation.optimise()
      • LLMBasedHierarchisation.run()
  • olaf.pipeline.pipeline_component.concept_relation_hierarchy.subsumption_hierarchisation module
    • SubsumptionHierarchisation
      • SubsumptionHierarchisation.check_resources()
      • SubsumptionHierarchisation.get_performance_report()
      • SubsumptionHierarchisation.optimise()
      • SubsumptionHierarchisation.run()
  • Module contents
• olaf.pipeline.pipeline_component.term_extraction package
  • Submodules
  • olaf.pipeline.pipeline_component.term_extraction.c_value_term_extraction module
    • CvalueTermExtraction
      • CvalueTermExtraction.check_resources()
      • CvalueTermExtraction.get_performance_report()
      • CvalueTermExtraction.optimise()
      • CvalueTermExtraction.run()
  • olaf.pipeline.pipeline_component.term_extraction.llm_term_extraction module
    • LLMTermExtraction
      • LLMTermExtraction.check_resources()
      • LLMTermExtraction.get_performance_report()
      • LLMTermExtraction.optimise()
      • LLMTermExtraction.run()
  • olaf.pipeline.pipeline_component.term_extraction.manual_candidate_terms module
    • ManualCandidateTermExtraction
      • ManualCandidateTermExtraction.check_resources()
      • ManualCandidateTermExtraction.get_performance_report()
      • ManualCandidateTermExtraction.optimise()
      • ManualCandidateTermExtraction.run()
  • olaf.pipeline.pipeline_component.term_extraction.pos_term_extraction module
    • POSTermExtraction
      • POSTermExtraction.check_resources()
      • POSTermExtraction.get_performance_report()
      • POSTermExtraction.optimise()
      • POSTermExtraction.run()
  • olaf.pipeline.pipeline_component.term_extraction.term_extraction_schema module
    • TermExtractionPipelineComponent
      • TermExtractionPipelineComponent.apply_post_processing()
      • TermExtractionPipelineComponent.check_resources()
      • TermExtractionPipelineComponent.get_performance_report()
      • TermExtractionPipelineComponent.optimise()
      • TermExtractionPipelineComponent.run()
  • olaf.pipeline.pipeline_component.term_extraction.tfidf_term_extraction module
    • TFIDFTermExtraction
      • TFIDFTermExtraction.check_resources()
      • TFIDFTermExtraction.get_performance_report()
      • TFIDFTermExtraction.optimise()
      • TFIDFTermExtraction.run()
  • Module contents

Submodules

olaf.pipeline.pipeline_component.pipeline_component_schema module

class olaf.pipeline.pipeline_component.pipeline_component_schema.PipelineComponent

Bases: ABC

A pipeline component is part of a pipeline performing one specific task.

abstract check_resources() → None

Method to check that the component has access to all its required resources.

abstract get_performance_report() → Dict[str, Any]

A getter for the pipeline component performance report.

If the component has been optimised, it only returns the best performance. Otherwise, it returns the results obtained with the set parameters.

Returns

Dict[str, Any]

The pipeline component performance report.

abstract optimise() → None

A method to optimise the pipeline component by tuning the options.

abstract run(pipeline: Pipeline) → None

Method that is responsible for the execution of the component.

Parameters

pipelinePipeline

The pipeline running

Module contents