Skip to main content

A Python toolkit for chain-of-thought prompting

Project description

Cogitator Logo

Cogitator

Tests Code Coverage Code Quality Python Version PyPI Version
Docs License DOI

A Python Toolkit for Chain-of-Thought Prompting


Cogitator is a Python toolkit for experimenting and working with chain-of-thought (CoT) prompting methods in large language models (LLMs). CoT prompting improves LLM performance on complex tasks (like question-answering, reasoning, and problem-solving) by guiding the models to generate intermediate reasoning steps before arriving at the final answer. Additionally, it can be used to improve the interpretability of LLMs by providing insight into the model's reasoning process. The toolkit aims to make it easier to use popular CoT strategies and frameworks for research or integrating them into AI applications.

Features


Getting Started

You can install Cogitator with

pip install cogitator

Or, if you want to install from the latest version with examples and benchmarks included

git clone https://github.com/habedi/cogitator && cd cogitator

# Set up Python environment (use Poetry 2.0+)
pip install poetry
poetry install --all-extras

# Run the tests to make sure everything is working (optional)
poetry run pytest

Examples

Below is a simple example of using the Self-Consistency CoT with Ollama.

import logging
from cogitator import SelfConsistency, OllamaLLM

# Step 1: Configure logging (optional, but helpful)
logging.basicConfig(level=logging.INFO)
logging.getLogger("httpx").setLevel(logging.WARNING)  # Suppress HTTPX logs

# Step 2: Initialize the LLM (using Ollama)
# Needs Ollama running locally with the model pulled (e.g., `ollama pull gemma3:4b`)
try:
    llm = OllamaLLM(model="gemma3:4b")
except Exception as e:
    print(f"Error initializing Ollama LLM: {e}")
    print("Please make sure Ollama is running and the model is pulled.")
    exit(1)

# Step 3: Choose a CoT strategy (Self-Consistency in this case)
# Self-Consistency generates multiple reasoning paths and finds the most common answer
sc_strategy = SelfConsistency(
    llm,
    n_samples=5,  # Number of reasoning paths to generate
    temperature=0.7  # Higher temperature can lead to more diverse answers
)

# Step 4: Define the prompt (with a basic CoT trigger)
question = "A bat and a ball cost $1.10 in total. The bat costs $1.00 more than the ball. How much does the ball cost?"
prompt = f"Q: {question}\nA: Let's think step by step."

# Step 5: Run the CoT prompting sc_strategy
print(f"\nQuestion: {question}")
print("Running Self-Consistency CoT...")
final_answer = sc_strategy.run(prompt)  # Returns the most consistent (repeated) answer

# Expected output: $0.05 or 0.05 (may vary slightly based on model and temperature)
print(f"\nCogitator's Answer (Self-Consistency): {final_answer}")

Check out the examples directory for more examples.


Documentation

Cogitator documentation is available here.


Benchmarking Framework

This project includes a customizable and extensible benchmarking framework to evaluate the performance of different CoT strategies on various datasets like GSM8K and StrategyQA.

Check out the benches directory for more details about the framework and how it could be used.


Contributing

See CONTRIBUTING.md for details on how to make a contribution.

Citations

If you find this project useful, please give it a star! If you have any questions or feedback, please use the discussion section of the repository or open an issue. If you use this project in your research, please consider citing using the following information:

@software{abedi_cogitator_2025,
    author = {Abedi Firouzjaei, Hassan},
    title = {{Cogitator: A Python Toolkit for Chain-of-Thought Prompting}},
    year = {2025--},
    publisher = {Zenodo},
    doi = {10.5281/zenodo.15331821},
    url = {https://github.com/habedi/cogitator}
}

License

Cogitator is licensed under the MIT License.

Acknowledgements

  • The logo is named "Cognition" and was originally created by vectordoodle.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cogitator-0.2.0.tar.gz (50.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cogitator-0.2.0-py3-none-any.whl (59.5 kB view details)

Uploaded Python 3

File details

Details for the file cogitator-0.2.0.tar.gz.

File metadata

  • Download URL: cogitator-0.2.0.tar.gz
  • Upload date:
  • Size: 50.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.10.19 Linux/6.11.0-1018-azure

File hashes

Hashes for cogitator-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f700b8e1ec2901ee7336e851346e52af55846a3d218380a42c91ddffd3761f99
MD5 be0bbc4c2999a7180a427ae20fded809
BLAKE2b-256 8d74e1c0c2fa80914177610f7e48196400792eb00655a35302291c44a0afa834

See more details on using hashes here.

File details

Details for the file cogitator-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: cogitator-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 59.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.10.19 Linux/6.11.0-1018-azure

File hashes

Hashes for cogitator-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 437f24a24069086f5077694a30cc9e7446f98118d690309ed11d5985f7c9fe6c
MD5 ad6309a996a8df464e5d0255c71fd53b
BLAKE2b-256 12780a63c97be143bc34598202a1d70e32b284d85bad2a4aa5c397ed98a53f4d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page