.. Academic Metrics documentation master file, created by
   sphinx-quickstart on Sun Nov 24 12:41:01 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Academic Metrics Documentation
============================================

AI System
----------
.. toctree::
   :maxdepth: 2
   :caption: Generative AI Classification System:

   AI

Prompts
--------
.. toctree::
   :maxdepth: 2
   :caption: Prompts used in the AI system:

   ai_prompts

ChainBuilder
--------------
.. toctree::
   :maxdepth: 2
   :caption: Langchain wrapper for quickly building LLM chains:

   ChainBuilder

Core
----
.. toctree::
   :maxdepth: 2
   :caption: Core data processing and formatting:

   core

Configuration
-------------
.. toctree::
   :maxdepth: 2
   :caption: Logging configuration and constants:

   config

Constants
---------
.. toctree::
   :maxdepth: 2
   :caption: Constants used for directory paths and execution time:

   constants

Data Collection
---------------
.. toctree::
   :maxdepth: 2
   :caption: Crossref API and Scraping:

   data_collection

Data Classes
-------------
.. toctree::
   :maxdepth: 2
   :caption: Data class models used throughout the system:

   dataclass_models

Database
--------
.. toctree::
   :maxdepth: 2
   :caption: Class for interacting with the database:

   DB

Enums
------
.. toctree::
   :maxdepth: 2
   :caption: Enums used for type safety in factory/decorator/strategy patterns:

   enums

Factories
----------
.. toctree::
   :maxdepth: 2
   :caption: Factory classes for creating objects:

   factories

Orchestrators
--------------
.. toctree::
   :maxdepth: 2
   :caption: Orchestrator classes for AI system and data processing:

   orchestrators

Other
------
.. toctree::
   :maxdepth: 2
   :caption: Taxonomy string representation:

   other

Postprocessing
---------------
.. toctree::
   :maxdepth: 2
   :caption: Duplicate detection and removal:

   postprocessing

Runners
-------
.. toctree::
   :maxdepth: 2
   :caption: Runner classes for executing the entire pipeline:

   runners

Strategies
-----------
.. toctree::
   :maxdepth: 2
   :caption: Strategy classes:

   strategies

Utils
------
.. toctree::
   :maxdepth: 2
   :caption: Utility classes and functions:

   utils

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`