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

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()
responses = 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
0 0.15 2020-07-12 00:00:00+00:00 2020-07-01 00:00:00+00:00
1 0.25 2021-06-15 00:00:00+00:00 2021-06-01 00:00:00+00:00

Examples

See examples.

TODO

  • handle errors

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.3.tar.gz (10.7 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.3-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: txt2dataset-0.5.3.tar.gz
  • Upload date:
  • Size: 10.7 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.3.tar.gz
Algorithm Hash digest
SHA256 34a7e73b986fb7b132e455d0cfe95b6e734791d254405fd0488a044254e0a80c
MD5 63e8aba935c25a1400b4b229237e69c4
BLAKE2b-256 7c42451347ac4a9be7c19271ae728a9422734d1204f000bfcfdc0a8fd4a3d1cd

See more details on using hashes here.

File details

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

File metadata

  • Download URL: txt2dataset-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 12.3 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 74f2b47b79c1b438e747e6c12d35f17211393393d5e62f9229298492b3e00120
MD5 b094336454c906842002552741f02d30
BLAKE2b-256 77da291d9f83a1ed33ac34fd193110fedad8563c923ee301bb9a84a9b83a8343

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