README.md

ScandiNLI

Natural language inference for the Scandinavian languages

---

Developers:

• Dan Saattrup Nielsen ([email protected])

Setup

Set up the environment

1. Run make install, which installs Poetry (if it isn't already installed), sets up a virtual environment and all Python dependencies therein.
2. Run source .venv/bin/activate to activate the virtual environment.

Install new packages

To install new PyPI packages, run:

$ poetry add <package-name>

Auto-generate API documentation

To auto-generate API document for your project, run:

$ make docs

To view the documentation, run:

$ make view-docs

Tools used in this project

• Poetry: Dependency management
• hydra: Manage configuration files
• pre-commit plugins: Automate code reviewing formatting
• pdoc: Automatically create an API documentation for your project

Project structure

.
├── .flake8
├── .github
│   └── workflows
│       ├── ci.yaml
│       └── docs.yaml
├── .gitignore
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── config
│   ├── __init__.py
│   └── config.yaml
├── data
├── makefile
├── models
├── notebooks
├── poetry.toml
├── pyproject.toml
├── src
│   ├── scandinli
│   │   ├── __init__.py
│   │   ├── build_data.py
│   │   └── train.py
│   └── scripts
│       ├── build_data.py
│       ├── fix_dot_env_file.py
│       ├── train.py
│       └── versioning.py
└── tests
    ├── __init__.py
    ├── conftest.py
    ├── test_build_data.py
    └── test_train.py