Metadata-Version: 2.4
Name: ai-starter-kit
Version: 0.3.0
Summary: Importable modules for learning machine learning and deep learning.
Project-URL: Homepage, https://github.com/mikovilla/ai-starter-kit
Project-URL: Issues, https://github.com/mikovilla/ai-starter-kit/issues
Author-email: Miko Villa <dev@mikovilla.com>
License: MIT
License-File: LICENSE
Keywords: ai,deep-learning,machine-learning,nlp,starter-kit
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.9
Requires-Dist: nltk>=3.8
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == 'dev'
Description-Content-Type: text/markdown

# ai-starter-kit

Importable modules for learning and starting machine learning / deep learning projects. Install it, import what you need.

## Install

```bash
pip install ai-starter-kit
```

## Available modules

| Module | Description |
|---|---|
| `ask.text` | Chains common NLP preprocessing steps (noise/punctuation removal, tokenization, stopword removal, stemming, lemmatization) behind a fluent `TextProcessor` API using NLTK. |

More modules will be added as the project grows.

### Text Processing

```python
from ask.text import TextProcessor, PartOfSpeech

processor = (
    TextProcessor(["Running, runners ran quickly through the running trails."])
    .to_lowercase()
    .remove_noise()
    .remove_punctuation()
    .tokenize()
    .remove_stopwords()
    .lemmatize(pos=PartOfSpeech.Verb)
)

print(processor.tokens)
```

## Development

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

```powershell
# Windows
powershell -ExecutionPolicy Bypass -File .\scripts\bootstrap.ps1
```

```bash
# macOS/Linux
./scripts/bootstrap.sh
```

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

```powershell
# Windows
. .\.venv\Scripts\Activate.ps1
pytest -v
```

```bash
# macOS/Linux
source .venv/bin/activate
pytest -v
```

## Contributing

New modules are welcome. Add a package under `src/ask/<name>/`, cover it with tests, then open a PR.

## License

MIT
