Skip to main content

Boilerplates and starter templates for learning machine learning and deep learning.

Project description

ai-starter-kit

Boilerplates for learning and starting machine learning / deep learning projects. Pick a template, copy it, run it.

Install

pip install ai-starter-kit

Usage

# See available templates
ai-starter-kit list

# Copy a template into the current directory
ai-starter-kit new text_processing

# Copy into a specific folder
ai-starter-kit new text_processing --dest ./my-project

Each template ships with its own requirements.txt — install those separately once you've copied a template, since they aren't bundled as dependencies of ai-starter-kit itself.

Available templates

Template Description
text_processing Chains common NLP preprocessing steps (noise/punctuation removal, tokenization, stopword removal, stemming, lemmatization) behind a fluent TextProcessor API using NLTK.

More templates will be added as the project grows.

Development

To set up a local environment for running the test suite:

# Windows
powershell -ExecutionPolicy Bypass -File .\scripts\bootstrap.ps1
# macOS/Linux
./scripts/bootstrap.sh

This creates a .venv, installs the package in editable mode, and pulls in dev/test dependencies (click, nltk, pytest). Then activate it and run the tests:

# Windows
. .\.venv\Scripts\Activate.ps1
pytest -v
# macOS/Linux
source .venv/bin/activate
pytest -v

Contributing

New templates are welcome. Add a folder under src/ai_starter_kit/templates/<name>/ with a main.py and requirements.txt, then open a PR.

License

MIT

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

ai_starter_kit-0.1.0.tar.gz (6.1 kB view details)

Uploaded Source

Built Distribution

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

ai_starter_kit-0.1.0-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

Details for the file ai_starter_kit-0.1.0.tar.gz.

File metadata

  • Download URL: ai_starter_kit-0.1.0.tar.gz
  • Upload date:
  • Size: 6.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for ai_starter_kit-0.1.0.tar.gz
Algorithm Hash digest
SHA256 819b43b200203ca89d0cab2ea8097bce630e41b79aae8722414bb02ae112446d
MD5 675ac60c8e2d7797370b2f2d1f29efb2
BLAKE2b-256 20c1e0ea6fb707ce26b35157092798667be68004d73f010b8fd57282c4e37191

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_starter_kit-0.1.0.tar.gz:

Publisher: publish.yml on mikovilla/ai-starter-kit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ai_starter_kit-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: ai_starter_kit-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.14

File hashes

Hashes for ai_starter_kit-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e6b361d21f7763475776d017a6b73313dcfd9d2acb89f0b36cdd3a3b5b439a5
MD5 ee7db54a3ac3b6fb004d12d27df4f660
BLAKE2b-256 d1c7c56f8105ed6f80880977647ece939193b70a16f00d929a5070c2c6d65b61

See more details on using hashes here.

Provenance

The following attestation bundles were made for ai_starter_kit-0.1.0-py3-none-any.whl:

Publisher: publish.yml on mikovilla/ai-starter-kit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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