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

[Ready to merge] Add Bonus Unit 5 #537

Merged
merged 7 commits into from
Jun 20, 2024
Merged

Conversation

Ivan-267
Copy link
Contributor

@Ivan-267 Ivan-267 commented Jun 5, 2024

Adds Bonus Unit 5. Imitation Learning with Godot RL Agents

TODO:

  • Upload and add link for downloading the zip file with starter/completed project.
  • Review the content and correct any other issues (a quick check performed with correction of smaller issues)

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

Copy link
Member

@simoninithomas simoninithomas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi,

First of all thank you for this excellent tutorial.

There's some small I changes I would like to see:
1️⃣ I put some recommanded changes
Mo̶v̶e̶ ̶y̶o̶u̶r̶ ̶f̶i̶l̶e̶s̶ ̶t̶o̶ ̶u̶n̶i̶t̶ ̶b̶o̶n̶u̶s̶ ̶4̶ ̶s̶i̶n̶c̶e̶ ̶t̶h̶e̶ ̶P̶P̶O̶ ̶b̶o̶n̶u̶s̶ ̶i̶s̶ ̶n̶o̶t̶ ̶r̶e̶a̶d̶y̶ ̶y̶e̶t̶ ̶a̶n̶d̶ ̶w̶e̶ ̶d̶o̶n̶'̶t̶ ̶k̶n̶o̶w̶ ̶w̶h̶e̶n̶ ̶i̶t̶ ̶w̶i̶l̶l̶ ̶b̶e̶ ̶p̶u̶b̶l̶i̶s̶h̶e̶d̶ ̶s̶o̶ ̶f̶o̶r̶ ̶n̶o̶w̶ ̶l̶e̶t̶'̶s̶ ̶a̶l̶l̶ ̶t̶h̶i̶s̶ ̶o̶n̶e̶ ̶b̶o̶n̶u̶s̶ ̶u̶n̶i̶t̶ ̶4̶.̶ -> We don't do that finally because their unit on PPO is almost ready.

I'm preparing the thumbnail and will publish it on this PR so that you can provide your feedback.

units/en/unitbonus5/the-environment.mdx Outdated Show resolved Hide resolved
units/en/unitbonus5/the-environment.mdx Outdated Show resolved Hide resolved
units/en/unitbonus5/train-our-robot.mdx Outdated Show resolved Hide resolved
@simoninithomas
Copy link
Member

Let me know what you think of the thumbnail @Ivan-267 @edbeeching

Unit bonus 4 thumbnail

@Ivan-267
Copy link
Contributor Author

Let me know what you think of the thumbnail @Ivan-267 @edbeeching

Unit bonus 4 thumbnail

Looks great!

@simoninithomas
Copy link
Member

simoninithomas commented Jun 13, 2024

Cool 🔥 @Ivan-267 I was thinking we can publish the unit tomorrow or monday/tuesday? What suits you best?

I gave some changes requests but overall, the unit is excellent 👏

@Ivan-267
Copy link
Contributor Author

Thanks for your review and making the image, I've sent some additional comments over E-mail.

Ivan-267 and others added 4 commits June 19, 2024 18:25
Adds the inference video to the train-our-robot section.
Adds the zip file link
Removes the normalization segment to avoid confusion, as not all of the values are currently normalized in the code.
@Ivan-267 Ivan-267 changed the title [WIP] Add Bonus Unit 5 🚧 [Ready to merge] Add Bonus Unit 5 Jun 20, 2024
Copy link
Contributor

@edbeeching edbeeching left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for iterating on this @Ivan-267 and @simoninithomas , LGTM!

@simoninithomas
Copy link
Member

Hi one last update is to put the link of the zip in the course and we're good to publish 🔥

@Ivan-267
Copy link
Contributor Author

Hi one last update is to put the link of the zip in the course and we're good to publish 🔥

Hey, I added the link here:

To get started, download the project from [here](https://huggingface.co/ivan267/imitation-learning-tutorial-godot-project/tree/main) (click on the download icon next to `GDRL-IL-Project.zip`). The zip file features both the “Starter” and “Complete” projects.

If you'd like I could change the link to direct link, but I wasn't sure how it works with the server so the current way was the safest.

The newer changes in the PR don't show up in the doc preview.

@simoninithomas
Copy link
Member

simoninithomas commented Jun 20, 2024

Yes I just saw I just launch the build PR documentation to check. But your link is correct

For the environmelnt repository I added a PR: https://huggingface.co/ivan267/imitation-learning-tutorial-godot-project/discussions/1

We can publish it this afternoon or any other day you prefer @Ivan-267 ?

@Ivan-267
Copy link
Contributor Author

Yes I just saw I just launch the build PR documentation to check. But your link is correct

For the environmelnt repository I added a PR: https://huggingface.co/ivan267/imitation-learning-tutorial-godot-project/discussions/1

We can publish it this afternoon or any other day you prefer @Ivan-267 ?

Thanks for adding the readme, I merged it. We can publish it today or whenever is convenient.

@simoninithomas
Copy link
Member

simoninithomas commented Jun 20, 2024

Hi what we can do is to publish it this afternoon 🔥 @edbeeching

What would be nice @Ivan-267 is:

  • A tweet with the video of the robot playing. with the link of the unit. For instance: "I wrote a tutorial on how to train a robot to play platform games using imitation learning
    Start learning now 👉 " something better but you got the idea 😅
  • Same with Linkedin.

If you want what we can do:

  • You write a short tweet on the fact you wrote a unit where people will train this small robot to play plaftorm games using imitation learning. You publish it with your account
  • I reshare with my account and try to reshare with HF account.
  • Same for Linkedin.
  • I write the announcement on discord by tagging rl people and tagging you.

So that your profile get promoted. But again tell me if you comfortable with that or if you have another idea?

@simoninithomas
Copy link
Member

I'm merging it thanks 🔥

@simoninithomas simoninithomas merged commit 8fc9353 into huggingface:main Jun 20, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants