Project setup improvement

.gitignore

@@ -0,0 +1,7 @@
+.venv/
+__pycache__/
+.vscode/
+logs/
+src/snake_ai_pytorch.egg-info/
+.pytest_cache/
+model/

.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+repos:
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.20.0
+    hooks:
+      - id: pyupgrade
+
+  - repo: https://github.com/MarcoGorelli/absolufy-imports
+    rev: v0.3.1
+    hooks:
+      - id: absolufy-imports
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+        exclude: ^src/pattern_identifier\.egg-info/
+      - id: end-of-file-fixer
+        exclude: ^src/pattern_identifier\.egg-info/
+      - id: check-yaml
+
+  - repo: https://github.com/PyCQA/bandit
+    rev: "1.8.3"
+    hooks:
+      - id: bandit
+        args: ["--exclude", ".tox,.eggs,tests"]
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.11.13" # Use the latest version
+    hooks:
+      - id: ruff
+        args: ["--fix", "--exit-non-zero-on-fix"]
+      - id: ruff-format
+        # args: ["--check"] # Use --check in CI if you only want to verify
+
+
+  # - repo: local
+  #   hooks:
+  #     - id: pytest-check
+  #       name: pytest-check
+  #       entry: pytest
+  #       language: system
+  #       pass_filenames: false
+  #       always_run: true

README.md

@@ -8,3 +8,36 @@ You can find all tutorials on my channel: [Playlist](https://www.youtube.com/pla
 - Part 2: Learn how to setup the environment and implement the Snake game.
 - Part 3: Implement the agent that controls the game.
 - Part 4: Implement the neural network to predict the moves and train it.
+
+## How to install
+
+```bash
+# Create virtual environment
+python -m venv .venv
+
+# Activate virtual environment
+source ./.venv/bin/activate
+
+# Install dependencies
+pip install -e .
+```
+
+## Evaluating the Neural Network
+
+### 1. Running the training
+
+```bash
+python src/snake_ai_pytorch/controllers/train.py
+```
+
+### 2. Seeing the trained agent play
+
+```bash
+python src/snake_ai_pytorch/controllers/enjoy.py
+```
+
+> ## To play yourself
+
+```bash
+python src/snake_ai_pytorch/controllers/play.py
+```