golem-workers 0.5.0

Golem Workers is an API providing direct and high-level access to CPU and GPU resources on the Golem Network.

golem-workers

Getting started

The are multiple ways to start interacting with golem-workers. Below are two of the most common ways to start it.

Docker example

Docker example will take care for installation, proper processes setup (golem-workers web server and golem-node service) and their basic configuration. Note that because of decentralized fashion, golem-node needs a few moments to gather information from the Golem Network, during that time, amount of returned proposals can be impacted.

To run docker example, checkout the repository and go to examples/docker directory, or directly copy its contents to your preferred destination.

1. Make sure that Docker is running on your machine and your current user have access to it.

2. Build and start docker compose project.

   docker compose up -d --build
   

3. Prepare some funds for Golem's free test network. Note that this step is needed mostly once per yagna-data volume.

   docker compose exec golem-node yagna payment fund
   

4. Golem-workers can be interacted with web api at http://localhost:8000. It's OpenApi Specification is available at http://localhost:8000/docs or http://localhost:8000/redoc

Web server

1. Install golem-workers via:

   pip install golem-workers
   

   This step should install yagna binary for the next steps.

2. Start golem-node instance. This will occupy your terminal session, so it's best to do it in separate session.

   yagna service run
   

3. Prepare some funds for Golem's free test network. Note that this step is needed mostly once per golem-node installation.

   yagna payment fund
   

4. Create new golem-node application token

   yagna app-key create <your-token-name>
   

   and put generated app-key into the .env file in the current directory

   YAGNA_APPKEY=<your-application-token>
   

5. If you want to use Golem Reputation put new entry in .env file in the current directory

   GLOBAL_CONTEXTS=["golem_reputation.ReputationService"]
   

6. Start golem-workers web server instance

   uvicorn golem_workers.entrypoints.web.main:app
   

7. Golem-workers can be interacted with web api at http://localhost:8000. It's OpenApi Specification is available at http://localhost:8000/docs or http://localhost:8000/redoc