Skip to main content

Convert text to datasets

Project description

txt2dataset

A package for building, standardizing and validating datasets using language models. Supports normal API as well as batch API.

Models Supported

  • Gemini - Make sure to set your "GEMINI_API_KEY" to environment.

Installation

pip install txt2dataset

Usage

Schema

from pydantic import BaseModel
from typing import Optional, List
from datetime import datetime

class SingleDividend(BaseModel):
    dividend_per_share: float
    payment_date: Optional[datetime] = None
    record_date: Optional[datetime] = None
    stock_type_specified: Optional[str] = None

class DividendExtraction(BaseModel):
    info_found: bool
    data: List[SingleDividend] = []

Entries

Entries consist of an identifier and the text to be structured.

entries = [{'id':0, 'context':
    """First Business Financial Services, Inc. (the "Company") issued a press release today 
    announcing that the Company's Board of Directors declared a quarterly dividend of $0.18 
    per share on April 30, 2021, unchanged compared to the last quarterly dividend per share. 
    The dividend is payable on May 24, 2021 to shareholders of record on May 10, 2021. 
    Also on July 12, 2020 there was a payable dividend of $0.15 per share to shareholders 
    of record on July 1st, 2020."""},

    {"id":1,"context": """XYZ Corp declared a dividend of $0.25 per share, payable June 15, 2021 
    to shareholders of record as of June 1, 2021."""}
]

Prompt

Choose a prompt such as:

prompt = "Extract ALL dividend information from this text"

Dataset Builder

Choose the requests per minute that work for your api key and model.

from txt2dataset import GeminiAPIBuilder

builder = GeminiAPIBuilder()
results = builder.build(prompt=prompt, schema=DividendExtraction, model="gemini-2.5-flash-lite",
               entries=entries, rpm=4_000, tpm=4_000_000, rpm_threshold=0.75, tpm_threshold=0.75)

Result

id dividend_per_share payment_date record_date stock_type_specified
0 0.18 2021-05-24 00:00:00+00:00 2021-05-10 00:00:00+00:00 quarterly
0 0.15 2020-07-12 00:00:00+00:00 2020-07-01 00:00:00+00:00 quarterly
1 0.25 2021-06-15 00:00:00+00:00 2021-06-01 00:00:00+00:00

Spot Checking

Use spotcheck() to check if results look good. Highly recommended to use a more powerful model for spot checking, and cheap model for dataset generation.

spotchecks = builder.spotcheck(prompt=prompt, schema=DividendExtraction, model="gemini-2.5-flash", entries=entries,
               results=results, sample_size = 10, rpm=4_000, tpm=4_000_000, rpm_threshold=0.75, tpm_threshold=0.75)

Result

id correct desc
1 true
0 false The stock_type_specified for the $0.15 dividend is incorrectly listed as 'quarterly'; the source text does not explicitly state it for this particular dividend, so it should be null.

Spot Checking Visualization

Use spotcheck_visualize() for an interactive visual method.

builder.spotcheck_visualize(prompt=prompt, schema=DividendExtraction, model="gemini-2.5-flash", entries=entries,
               results=results, sample_size = 10, rpm=4_000, tpm=4_000_000, rpm_threshold=0.75, tpm_threshold=0.75)

spot check visualization

Examples

See examples.

TODO

  • handle errors
  • spotcheck
  • standardize
  • store rate limits across multiple build commands

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

txt2dataset-0.5.6.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

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

txt2dataset-0.5.6-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file txt2dataset-0.5.6.tar.gz.

File metadata

  • Download URL: txt2dataset-0.5.6.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for txt2dataset-0.5.6.tar.gz
Algorithm Hash digest
SHA256 e2387d8eeda3f41db272e931698e434311929a5bd8a1232063124485318117e5
MD5 8b6503fc44a2062b77931a09d79054b0
BLAKE2b-256 9f0148eaf9b1dcb00fcfd5fc8f2cae983af5db7e280f2747b3013a893fd16be3

See more details on using hashes here.

File details

Details for the file txt2dataset-0.5.6-py3-none-any.whl.

File metadata

  • Download URL: txt2dataset-0.5.6-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.15

File hashes

Hashes for txt2dataset-0.5.6-py3-none-any.whl
Algorithm Hash digest
SHA256 338f946e01a5fc9e54976b1838862ee459519fef87994f41c98959388bc9e900
MD5 54f88705453207ed1996c1580086f2d6
BLAKE2b-256 161a31bdec0e5aed930bfd65907e79a017791442649719218a9242686900a48f

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