No project description provided
Project description
CLTrier NLP: academic teaching toolbox
Usage
Install
pip install cltrier_nlp
Development
Install
The project is managed by Poetry, a dependency management and packaging library. Please set up a local version according to the official installation guidelines. When finished, install the local repository as follows:
# install package dependencies
poetry install
# add pre-commit to git hooks
poetry run pre-commit install
Tests
poetry run pytest
Linting
poetry run pre-commit run --all-files
Project Structure
│
├── Makefile <- Makefile containing development targets
├── README.md <- top-level README
├── pyproject.toml <- package-level (poetry) configuration
├── mkdocs.yaml <- documentation configuration
├── .pre-commit-config.yaml <- git pre-commit actions
│
├── cltrier_nlp <- root source
│ └── corpus <- nltk inspired corpus module
│ └── encoder <- huggingface auto model wrapper
│ └── trainer <- pytorch training algorithm
│ └── functional <- generic helper functions
│ └── utility <- utility classes and types
│
├── tests <- unittests
│
├── examples <- usage/application examples
│
├── scripts <- additional package building scripts
│ └── gen_docs_pages.py <- automatic doc generation based on docstrings
│
ToDos
- tests: add encoder testing
- tests: add functional testing
- tests: add utility testing
- cltrier_nlp:trainer: modernize and refactor
- examples:application: encoder with manifold reduction
- examples:application: encoder with unsupervised clustering
- examples:application: training pipeline with pytorch MLP
Resources
- Project Template (Data Science): https://github.com/drivendata/cookiecutter-data-science
- Project Template (Poetry): https://github.com/fpgmaas/cookiecutter-poetry
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
cltrier_nlp-0.1.8.tar.gz
(15.3 kB
view hashes)
Built Distribution
Close
Hashes for cltrier_nlp-0.1.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a3a0aab926aa58dadfcf6abbec10792b94b19f090e8a9f37bbd2ceff88c2c8f9 |
|
MD5 | c64a6d83c30fe95eaeb857b279fc68de |
|
BLAKE2b-256 | d76c4ae307fc01478b0a092b5c4a26d616bb2c9fae3a75a70fb0d6c4428bb0f5 |