Skip to main content
Ctrl+K

Academic Metrics

  • AI package
  • Prompt Templates
  • ChainBuilder package
  • core package
  • Global Configuration
    • constants package
    • data_collection package
    • dataclass_models package
    • DB package
    • enums package
    • factories package
    • orchestrators package
    • other package
    • postprocessing package
    • runners package
    • strategies package
    • utils package
  • GitHub
  • AI package
  • Prompt Templates
  • ChainBuilder package
  • core package
  • Global Configuration
  • constants package
  • data_collection package
  • dataclass_models package
  • DB package
  • enums package
  • factories package
  • orchestrators package
  • other package
  • postprocessing package
  • runners package
  • strategies package
  • utils package
  • GitHub

Table of Contents

Generative AI Classification System:

  • AI package

Prompts used in the AI system:

  • Prompt Templates

Langchain wrapper for quickly building LLM chains:

  • ChainBuilder package

Core data processing and formatting:

  • core package

Logging configuration and constants:

  • Global Configuration

Constants used for directory paths and execution time:

  • constants package

Crossref API and Scraping:

  • data_collection package

Data class models used throughout the system:

  • dataclass_models package

Class for interacting with the database:

  • DB package

Enums used for type safety in factory/decorator/strategy patterns:

  • enums package

Factory classes for creating objects:

  • factories package

Orchestrator classes for AI system and data processing:

  • orchestrators package

Taxonomy string representation:

  • other package

Duplicate detection and removal:

  • postprocessing package

Runner classes for executing the entire pipeline:

  • runners package

Strategy classes:

  • strategies package

Utility classes and functions:

  • utils package

Indices

  • General Index
  • Python Module Index
  • Overview: module code

All modules for which code is available

  • academic_metrics.AI.abstract_classifier
  • academic_metrics.ChainBuilder.ChainBuilder
  • academic_metrics.DB.DatabaseSetup
  • academic_metrics.configs.global_config
  • academic_metrics.core.category_processor
  • academic_metrics.data_collection.CrossrefWrapper
  • academic_metrics.data_collection.scraper
  • academic_metrics.dataclass_models.abstract_base_dataclass
  • academic_metrics.dataclass_models.concrete_dataclasses
  • academic_metrics.enums.dataclass_enums
  • academic_metrics.enums.enums
  • academic_metrics.factories.abstract_classifier_factory
  • academic_metrics.factories.dataclass_factory
  • academic_metrics.factories.strategy_factory
  • academic_metrics.orchestrators.category_data_orchestrator
  • academic_metrics.orchestrators.classification_orchestrator
  • academic_metrics.postprocessing.BasePostprocessor
  • academic_metrics.postprocessing.DepartmentPostprocessor
  • academic_metrics.postprocessing.FacultyPostprocessor
  • academic_metrics.runners.pipeline
  • academic_metrics.strategies.AttributeExtractionStrategies
  • academic_metrics.utils.api_key_validator
  • academic_metrics.utils.minhash_util
  • academic_metrics.utils.taxonomy_util
  • academic_metrics.utils.utilities
  • academic_metrics.utils.warning_manager
  • constants.dir_paths
  • typing

© Copyright 2024, Spencer Presley, Cole Barbes.

Created using Sphinx 8.1.3.

Built with the PyData Sphinx Theme 0.16.1.