Skip to main content

proofread-eng-scify, an ALM

An artisanal language model (ALM) for proofreading English prose in the style of old-old-school science fiction, like Jules Verne, Lewis Carroll, and L. Frank Baum.


For someone who wants to use the proofreader

Installation

Using the proofreader


For someone who wants to modify the proofreader

Testing

From the top level project directory, run

uv run pytest

Running evaluations

evals/

How the code is organized

Model development code sits in the top level model_dev/ directory. Once models have been created and tested and are ready to be used in the proofreader, they are moved to the src/proofread_eng_scify/models/ directory. Versions are indicated with a two digit squential counter appended to the model name, such as tokenizer_13.

Tests are scattered throughout the code, sitting close to the code they are meant to test. They are primarily unit tests. For now, integration and end-to-end testing gets covered by evaluations.

Evaluations are in evals/

Release files for proofread-eng-scifi 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for proofread-eng-scifi 0.1.0
File Size Uploaded
proofread_eng_scifi-0.1.0.tar.gz 1.8 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for proofread-eng-scifi 0.1.0
File Interpreter ABI Platform
proofread_eng_scifi-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 1.8 MB

Release files / proofread_eng_scifi-0.1.0.tar.gz

Download URL proofread_eng_scifi-0.1.0.tar.gz
Size 1.8 MB
Tags Source
SHA-256 checksum
How to use checksums
87a82f77547f920a3eb6893b61a22fee7e8203184479271b2d474a515c72eb7c
BLAKE2b-256 checksum
How to use checksums
a8845fcadedbb494523236188822bc8d4f5d79562d905edf5d7c5503350fdeaf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.1

Release files / proofread_eng_scifi-0.1.0-py3-none-any.whl

Download URL proofread_eng_scifi-0.1.0-py3-none-any.whl
Size 15.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e97f2c0094196a376a4d7ad0e8cf954e70501f321700943cbcae81e99a0acbc3
BLAKE2b-256 checksum
How to use checksums
cc94af399cb2aed16450f3da0598ac1af2b85a200801f3ee806611ef2a6bced2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via uv/0.5.1

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page