A libray that helps you to learn Artificial Intelligence.
Project description
AIGYM
The goal of this libray is provide a set of tools to help you to learn Artificial Intelligence.
How to setup the environment
To avoid any configuration problems, we recommend creating a virtual environment with python:
python3 -m virtualenv venv
source venv/bin/activate
python -m pip install --upgrade pip
pip install -r requirements.txt
To quit the virtual environment, type deactivate
. If you already have the virtual environment configured then type source venv/bin/activate
.
How to test the project
To run the tests, please type in the root directory:
export PYTHONPATH=.
pytest tests
How to upgrade the package
If you need to upgrade the package, please follow these steps:
- change what you need in the code;
- test it :smile: ;
- describe what you did in the Changelog.md file;
- change the
setup.py
file. In special, theversion
attribute; - commit and push the changes on
main
branch; - then do the same on the
stable
branch;
We have two workflows in the GitHub Actions:
- to publish the package in the PyPI when you push something in the
stable
branch. This workflow does the same as:
python setup.py sdist
twine upload dist/*
- to publish the website (documentation) in the GitHub Pages.
How to install the package
pip install aigyminsper
Change log
The change log of this library is in the Changelog.md file.
Documentation
The documentation of this library is in the docs folder. We are using MkDocs to generate the documentation.
To see the documentation in your local machine, please type:
mkdocs serve
To deploy a new version of the documentation, please merge the content in the stable branch:
git checkout stable
git merge master
git push
There is a GitHub Action that will deploy the documentation in the GitHub Pages.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.