crunch-model-runner 0.1.1

No project description provided

Model Runner

Getting Started

To get started with this project, follow the steps below:

Prerequisites

Make sure you have the following installed:

• Python 3.11.10 or later
• Poetry package manager

Installation

1. Clone the repository:

   git clone <repository_url>
   cd <project_folder>
   

2. Use Poetry to install the dependencies:

   poetry install
   

3. Activate the Poetry virtual environment:

   poetry shell
   

Generating Protocol Buffers

This project uses gRPC for communication. You can generate the necessary gRPC code if you change the [model_runner.proto](model_runner/protos/model_runner.proto) file by using the following command:

poetry run _generate-proto

Ensure all .proto files are present in the appropriate directory before running the above command.

Running the Project

Once dependencies are installed, you can run the main application using:

poetry run python __main__.py --code-directory tests/models_examples/bill

Replace --code-directory with the path to the directory containing the code that should be made available remotely.

Running Tests

To run the tests for this project, execute: Make sure the gRPC server is correctly set up and running before running the tests. (Next version of tests will introduce this automatically)

poetry run pytest

Publishing

Currently, code delivery is done through a build and push to S3, where the orchestrator retrieves it to build a Docker image (to improve in the futur)

poetry run _build-publish

Additional Notes

• If you need to add new dependencies, use:

  poetry add <package_name>