Skip to content

Latest commit

 

History

History

custom_activity

README.md

atmospherex-activity-base

Folder containing the base code to implement an activity custom code.

This folder should help create the following required manifests per custom code:

  • a fastapi server with the required endpoints which AtmosphereX will call
  • an artifact usable by the contextual bandit learner.

This project will need to be installed using pip in each custom code repository, allowing to extend the abstract class containing all the methods to implement. e.g.:

from atmosphere.custom_activity import BaseActivityCustomCode


class MyClass(BaseActivityCustomCode):
    ...

The pip command is:

pip install git+https://github.com/ambiata/atmosphere-python-sdk.git@{tag}

Fast validation

To validate fastly that the application has well been built without having to run unittest.

To check the server, after selecting your module you can run:

MODULE='abc' CLASS_NAME='Def' python -m atmosphere.custom_activity.server
The server started well

To check the mocker, after selecting your module, you can run:

$ ACTIVITY_INFERENCE_BASE_URL="abc" REQUESTS_PER_SECOND=3 OUTCOMES_TIMEOUT_SECONDS=10 OUTCOMES_RATE=0.5 MODULE='abc' CLASS_NAME='Def' python -m atmosphere.custom_activity.mocker.main_mocker test
All good, the mocker could start.

If these commands fail, it means that server or the mocker will not be able to start properly. This command will return at completion.

Production-ready Dockerfile example

Simple Dockerfile exmaple to run the base activity server

FROM python:3.8.5-slim

# install your module ...

ENV MODULE='path.to.the.module'
ENV CLASS_NAME='ClassName'

EXPOSE 8000

CMD ["uvicorn", "--host",  "0.0.0.0", "--port", "8000", "--timeout-keep-alive", "5", "--workers", "4", "atmosphere.custom_activity.server:server"]