Index | Module Index | Search Page

BibCat Documentation

This is the documentation for BibCat.

GETTING STARTED

• BibCAT
  • Development Workflow
  • Installation
    • Required packages and versions
    • Conda environment installation
    • BibCAT installation
    • Spacy model downloads
  • pre-commit for development
    • Install pre-commit
  • Setup
    • Input Data files
    • User Configuration and Data Filepaths
    • When testing with pytest
    • Building the documentation
  • Quick start
    • Build The Dataset
    • Using LLM Prompting Method
  • License
  • Contributing
• Changelog
  • Unreleased
    • Added
    • Changed
    • Fixed
    • Deprecated
    • Removed
    • Security
  • [0.2.6] - 2026-5-20
    • Added
    • Changed
    • Removed
  • [0.2.5] - 2026-3-31
    • Removed
  • [0.2.4] - 2025-12-15
    • Added
    • Changed
    • Fixed
  • [0.2.2] - 2025-09-29
    • Added
    • Changed
    • Fixed
  • 0.2.1 - 2025-09-26
    • Changed
  • 0.2.0 - 2025-09-22
    • Removed
    • Changed
    • Added
  • 0.1.0 - 2024-01-29

About the Data

• Input text data

LLM

• Using LLM Prompting
  • Quick Start
  • Submitting a paper
    • Running within Python
  • Batch Processing
    • Synchronous Batch Submission
    • Asynchronous Batch Submission with OpenAI Batch API
  • User Configuration
  • User and Agent (System) Prompts
    • Testing New Prompts
  • File Uploads
  • Response Output
  • Evaluating Output
    • Output Columns
    • Example Output
    • Batch Evaluation
  • Plotting Evaluation Plots
    • Confusion Matrix Plot
    • Metrics Summary Output
    • Receiver Operating Characteristic (ROC) Plot
  • Statistics output
    • Evaluation summary statistics for mission+papertype pairs
    • Operation classification statistics for mission+papertype pairs
    • Statistics Output columns
    • Audit inconsistent classifications

Packages and Modules

• Command-Line Tool
  • Quick Reference
  • Complete Reference
• bibcat
  • bibcat package
    • Subpackages
    • Submodules
    • bibcat.main module
    • Module contents

• Index

• Module Index

• Search Page