Search Experiments | InNoHassle ecosystem

Table of contents

Did you know that GitHub supports table of contents by default 🤔

About

This is repository for our machine learning experiments for search engine.

Technologies

• Python 3.12 & Poetry
• Formatting and linting: Ruff, pre-commit
• Deployment: Docker, Docker Compose, GitHub Actions

Development

Getting started

1. Install Python 3.12

2. Install Poetry

3. Install project dependencies with Poetry.

   poetry install

4. Set up pre-commit hooks:

   poetry run pre-commit install --install-hooks -t pre-commit -t commit-msg

Set up PyCharm integrations

1. Ruff (plugin). It will lint and format your code. Make sure to enable Use ruff format option in plugin settings.
2. Pydantic (plugin). It will fix PyCharm issues with type-hinting.
3. Conventional commits (plugin). It will help you to write conventional commits.

FAQ

How to update dependencies?

Project dependencies

1. Run poetry update to update all dependencies
2. Run poetry show --outdated to check for outdated dependencies
3. Run poetry add <package>@latest to add a new dependency if needed

Pre-commit hooks

1. Run poetry run pre-commit autoupdate

Contributing

We are open to contributions of any kind. You can help us with code, bugs, design, documentation, media, new ideas, etc. If you are interested in contributing, please read our contribution guide.