Skip to main content

Python SDK for Lightning Rod AI-powered forecasting dataset generation

Project description

Lightning Rod Labs

Lightning Rod Python SDK Beta

The Lightning Rod SDK provides a simple Python API for generating custom forecasting datasets to train your LLMs. Transform news articles, documents, and other real-world data into high-quality training samples automatically.

Based on our research: Future-as-Label: Scalable Supervision from Real-World Outcomes

👋 Quick Start

1. Install the SDK

pip install lightningrod-ai

2. Get your API key

Sign up at dashboard.lightningrod.ai to get your API key and $50 of free credits.

3. Generate your first dataset

Generate 1000+ forecasting questions in minutes - from raw sources to labeled dataset, automatically. ⚡

from lightningrod import LightningRod, BinaryAnswerType, QuestionPipeline, NewsSeedGenerator, ForwardLookingQuestionGenerator, WebSearchLabeler

lr = LightningRod(api_key="your-api-key")

binary_answer = BinaryAnswerType()

pipeline = QuestionPipeline(
    seed_generator=NewsSeedGenerator(
        start_date=datetime.now() - timedelta(days=90),
        end_date=datetime.now(),
        search_query=["Trump"],
    ),
    question_generator=ForwardLookingQuestionGenerator(
        instructions="Generate binary forecasting questions about Trump's actions and decisions.",
        examples=[
            "Will Trump impose 25% tariffs on all goods from Canada by February 1, 2025?",
            "Will Pete Hegseth be confirmed as Secretary of Defense by February 15, 2025?",
        ]
    ),
    labeler=WebSearchLabeler(answer_type=binary_answer),
)

dataset = lr.transforms.run(pipeline, max_questions=3000)
dataset.flattened(binary_answer)  # Ready-to-use data for your training pipelines

We use this to generate the Future-as-Label training dataset for our research paper.

✨ Examples

We have some example notebooks to help you get started! If you have trouble using the SDK, please submit an issue on Github.

Tutorials

Example Name Path Google Colab Link
Quick Start notebooks/01_quick_start.ipynb Open in Colab
News Datasource notebooks/02_news_datasource.ipynb Open in Colab
Custom Documents notebooks/03_custom_documents_datasource.ipynb Open in Colab
Binary Answer Type notebooks/04_binary_answer_type.ipynb Open in Colab
Continuous Answer Type notebooks/05_continuous_answer_type.ipynb Open in Colab
Multiple Choice Answer Type notebooks/06_multiple_choice_answer_type.ipynb Open in Colab
Free Response Answer Type notebooks/07_free_response_answer_type.ipynb Open in Colab

End-to-end

Example Name Path Google Colab Link
Golf Forecasting notebooks/e2e/golf_forecasting.ipynb Open in Colab
Trump Forecasting notebooks/e2e/trump_forecasting.ipynb Open in Colab
Document Classification notebooks/e2e/document_classification.ipynb Open in Colab
Polymarket Backtesting notebooks/e2e/polymarket_backtesting.ipynb Open in Colab
Model Consensus notebooks/e2e/model_consensus.ipynb Open in Colab

For complete API reference documentation, see API.md. This includes overview of the core system concepts, methods and types.

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

lightningrod_ai-0.1.15.tar.gz (81.8 kB view details)

Uploaded Source

Built Distribution

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

lightningrod_ai-0.1.15-py3-none-any.whl (169.2 kB view details)

Uploaded Python 3

File details

Details for the file lightningrod_ai-0.1.15.tar.gz.

File metadata

  • Download URL: lightningrod_ai-0.1.15.tar.gz
  • Upload date:
  • Size: 81.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for lightningrod_ai-0.1.15.tar.gz
Algorithm Hash digest
SHA256 422cd38dd4032b60a2d464fc057eeeefc4d1250343ec0e5caa21de4bb8359632
MD5 8c13b1c305d4389986c39ca548a9fd59
BLAKE2b-256 698500a9ff6503c6a18796f3503de85d0c94ef4b1dcccfb8e52e20711f169594

See more details on using hashes here.

File details

Details for the file lightningrod_ai-0.1.15-py3-none-any.whl.

File metadata

File hashes

Hashes for lightningrod_ai-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 d6b1fcf056f722f1ab074e5d4c816dcbc15bf350c11b1eb8ff54180888e05fec
MD5 1d7f650233a44e1ef93ae8e2d14cc98d
BLAKE2b-256 98e9d82ec0d9cd6c0b4cc816380aa3ee3647174cb22d3bd39aaf2478ddeff4db

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