semvec/pypi-packages huggingface dataset:
oddsgym 0.10.1
A sports betting environment for OpenAI Gym
Requires Python: >=3.8

# Sports odds betting environment 
[![PyPI version](https://badge.fury.io/py/oddsgym.svg)](https://badge.fury.io/py/oddsgym)
![build](https://github.com/OryJonay/Odds-Gym/workflows/build/badge.svg) 
[![Coverage Status](https://coveralls.io/repos/github/OryJonay/Odds-Gym/badge.svg?branch=master)](https://coveralls.io/github/OryJonay/Odds-Gym?branch=master)
[![Hatch project](https://img.shields.io/badge/tool-%F0%9F%A5%9A%20Hatch-4051b5.svg)](https://github.com/pypa/hatch) 
[![Endpoint Badge](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fastral-sh%2Fruff%2Fmain%2Fassets%2Fbadge%2Fv2.json&label=linting)](https://github.com/astral-sh/ruff) 
[![License - MIT](https://img.shields.io/badge/license-MIT-9400d3.svg)](https://spdx.org/licenses/) 
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/) 

A sports betting environment for [Farma Foundation Gymnasium](https://gymnasium.farama.org/) based environments.

## Installation

    pip install oddsgym

## Environment

The starting bank is X (X > 0), representing X available bets.
Actions are all available bets for a game (depends on sport), placing 1 bet for each option. Also, the agent can not bet over his current bank (i.e can't place 3 bets when the current bank is 2).
For example, in 3-way betting for soccer, the avilable actions are:

    1. Bet on home team
    2. Bet on away team
    3. Bet on draw
    4. Bet on home team and away team
    5. Bet on home team and draw
    6. Bet on away team and draw
    7. Bet on home team and away team and draw
    8. Don't place a bet for this game

A step is placing a bet on a single game. In each step, the agent knows the betting odds for this game.
The reward for each step is the amount of money won (negative reward when losing money).
An episode is betting for a whole year or when "striking out" (losing all the money).

## Documentation

The full documentation is hosted at: https://oryjonay.github.io/Odds-Gym