pip install cltrier_nlpThe 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 poetry run pytestpoetry run pre-commit run --all-filesβ
βββ 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
β
- 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
- Project Template (Data Science): https://github.com/drivendata/cookiecutter-data-science
- Project Template (Poetry): https://github.com/fpgmaas/cookiecutter-poetry
