Updated Instruction for 2025 PLR

.github/workflows/formatting.yaml

@@ -9,15 +9,4 @@ jobs:
         uses: lgeiger/black-action@master
         with:
           args: "--line-length 120 . --check"
-          name: black-action
-
-  auto-formatting:
-    name: runner / black
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Check files using the black formatter
-        uses: rickstaa/action-black@v1
-        id: action_black
-        with:
-          black_args: "--line-length 120 ."
+          name: black-action

.gitignore

@@ -0,0 +1,5 @@
+scripts/wandb/*
+scripts/images/*
+plr.egg-info/*
+2024_home_work/.venv/*
+.venv/*

.python-version

@@ -0,0 +1 @@
+3.8

README.md → 2024_home_work/README.md

@@ -29,7 +29,7 @@ code ~/.bashrc
 alias venv_plr="source ~/venv/plr/bin/activate"
 ```
 
-## Transforming scrips into a software project
+## Transforming scripts into a software project
 Create a fork of the project on GitHub
 ```shell
 cd ~/git
@@ -38,18 +38,18 @@ git clone [email protected]:leggedrobotics/plr-exercise.git
 
 Replace `leggedrobotics` with your `username`.
 
-Small notice you can clone a repo using ssh or https. 
-I recommend to setup ssh-keys and always use ssh. 
+Note that you can clone a repository using SSH or HTTPS.
+I recommend setting up SSH keys and always using SSH.
 
 Then go to the Github Settings to right:  
 ![alt text](docs/repo.jpg)
 
 
-Activate under General the following Features:  
+Under General, activate the following features:
 ![alt text](docs/features.jpg)
 
 ### Submission instructions
-You at first create a fork of the plr-exercise repository under your local GitHub username.  
+First, create a fork of the plr-exercise repository under your GitHub username. 
 For each task you create a branch called: `dev/task_X`  
 You commit all the changes necessary for this task to this branch and push the changes to GitHub.  
 To finish a task you create a pull request from `dev/task_X` to `main`. 
@@ -139,7 +139,7 @@ Add wandb logger.
 pip3 install wandb
 ```
 Follow the quickstart guide here: [https://docs.wandb.ai/quickstart](https://docs.wandb.ai/quickstart)  
-Log the training_loss, test_loss, and your code as an artificat.  
+Log the training_loss, test_loss, and your code as an artifact.  
 Create a PR with a screenshot of a run with the loss curve and the uploaded source code artifact.  
 
 
@@ -177,11 +177,11 @@ Here are some workflows by the RSL that may help you: [https://github.com/legged
 
 ## Bonus points
 
-You can get bonus points if you improve this version of this README by fixing errors or adding other usefull "tasks" below that you think will help others.
+You can get bonus points if you improve this version of this README by fixing errors or adding other useful "tasks" below that you think will help others.
 This may include: 
-- Improved Reproducability
+- Improved Reproducibility
 - Visualization
 - Configuration with Hydra, OmegaConfiguration
 - Measuring the time
 
-## Other usefull tasks [Bonus Points]
+## Other useful tasks [Bonus Points]

main.py

@@ -0,0 +1,6 @@
+def main():
+    print("Hello from plr!")
+
+
+if __name__ == "__main__":
+    main()

pyproject.toml

@@ -0,0 +1,40 @@
+[project]
+name = "plr"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+dependencies = [
+    "numpy",    "torch",
+    "pytictac",
+    "pre-commit",
+    "ruff",
+    "wandb",
+    "matplotlib",
+    "notebook",
+]
+authors = [{ name = "Jonas Frey", email = "[email protected]" }]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "License :: MIT",
+    "Operating System :: Linux 20.04",
+    "Programming Language :: Python :: 3.8",
+]
+
+[tool.setuptools]
+packages = ["plr"]
+
+[tool.black]
+line-length = 120
+target-version = ['py38']
+
+[tool.ruff]
+line-length = 120
+target-version = "py38"
+select = ["E", "F", "W"]  # Enable error, flake8, and warnings
+ignore = ["E741", "E501"]
+
+[tool.mypy]
+python_version = "3.8"
+strict = true