Provides access to computation resources on a single machine.
- Install dependencies with
pip install -r requirements.txt
- Make sure you have Docker installed and that your user has permissions to use it
- If you intend to run computations on a GPU, install also
The test suite can be run with
python setup.py test.
Launching the Shepherd
First, you need to have a Docker registry and a Minio server running. The easiest way to achieve this is to use the Docker Compose example:
docker-compose -f examples/docker/docker-compose-sandbox.yml up -d
Second, you need a configuration file. Again, examples found in the
folder are a great starting point. Feel free to pick one of those and edit it to
Finally, you need to run the following command to start the shepherd:
shepherd -c examples/configs/shepherd-docker-cpu.yml
Be sure to adjust the command line parameters according to your needs (
your host address,
-p is the port number where the shepherd API server listens
-c is the path to the configuration file).
After launching the shepherd, there will be an HTTP API available on the configured port that can be used to control the shepherd.
Processing a Request Directly
To process a request for debugging purposes, you need to:
- choose a request id
- create a bucket on your Minio server with a name same as your request id
- put the payload (input for the model) in
- invoke the
/start-jobAPI endpoint with your chosen request id
- after the job is processed, the result should be stored in Minio, in