update the documentation content, style and add hypertuning #9

	# This workflow will install Python dependencies and run tests and lint with a single version of Python
	# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions

	# Based on David Neuroth pylpg

	name: pytest

	on:
	push:
	pull_request:
	branches: [ main ]

	jobs:
	build:
	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v2
	- name: Set up Python 3.10
	uses: actions/setup-python@v2
	with:
	python-version: '3.10'
	- name: Install dependencies
	run: \|
	python -m pip install --upgrade pip
	pip install pytest
	pip install pytest-cov
	pip install codecov
	if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
	pip install --no-cache-dir -e .

	- name: Test with pytest
	working-directory: ./test/
	run: \|
	pytest
	codecov

Provide feedback