README.md

ml-tech-assessment

Environment Setup

Using Conda (Recommended)

1. Install Conda if you haven't already:

   • Download and install Miniconda or Anaconda

2. Create and activate a new conda environment:

   conda create -n ml-assessment python=3.12
   conda activate ml-assessment

Installing Poetry and Dependencies

1. Install Poetry using pip:

   pip install poetry

2. Install project dependencies:

   poetry install

Environment Variables

1. Create a .env file in the root directory of the project
2. Copy the contents of the provided .env file into your local .env file

Running Tests

To run the tests, make sure you have:

1. Activated your virtual environment
2. Installed all dependencies using Poetry
3. Created and populated the .env file

Then run:

pytest

For more detailed test output:

pytest -v

For test coverage report:

pytest --cov