ai library template

ai-library-template

This template contains CI/CD workflows and invoke tasks for an AI library.

Configuration

Add following items to repository secrets:

Name	Where to get it
CODECOV_TOKEN	Codecov
PYPI_TOKEN	PyPI

What do I need for an AI?

You need to implement at least the following classes from duo-game-lib:

• Player, represents the AI
• Judge, responsible for game rules

How to add an AI to tira-ai-platform?

1. Create new repository from this template

2. Implement the AI

3. Deploy the package to PyPI with deployment workflow

4. Add AI library to tira-ai-platform

   poetry add ai-library-name

5. Add factory method for the AI in PlayerFactory

6. Add factory method for the game with Judge class in GameFactory

Architecture

The relations between duo-game-lib classes can be found in architecture document of the main project. connect-four-lib can be used as an example for an AI library.

Deployment

• Update version in pyproject.toml, use semantic versioning
• Run "Deploy" workflow manually in GitHub Actions

Important

Before publishing the package to PyPI:

• Add repository secrets required in configuration
• Rename directory src/name_of_ai_lib to a desired name and update packages in pyproject.toml
• Change name in pyproject.toml