Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixed some typos in README.md ;) #32

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -52,19 +52,18 @@ Activate under General the following Features:
You at first create a fork of the plr-exercise repository under your local 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`.
To finish a task, you create a pull request from `dev/task_X` to `main`.
The title of the pull request is the task description below.
Do not delete the branches after merging the PR.

Task Descriptions:
- **Task 0:** Run train.py and create an issue and complain about your low test score.
- **Task 1:** Improve the formatting using black
- **Task 2:** Create a python package for your project
- **Task 3:** Add a online logging framework
- **Task 3:** Add an online logging framework
- **Task 4:** Use optuna to perform a hyperparameter search
- **Task 5:** Add docstrings to every file.


### Overview
You are given the `train.py` script.
Try to run the script:
@@ -109,7 +108,7 @@ We would like the repository structure to look as follows:

```yaml
project_name:
├──results:
├──results:
│ ├──YEAR_MONTH_DAY_TIME_experiment_name:
│ ├──results.yml
│ └──....
@@ -177,11 +176,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]