facebookresearch / nocturne

A data-driven, fast driving simulator for multi-agent coordination under partial observability.

MIT License

259 stars 29 forks source link

Nocturne intro tutorials #65

Closed daphnecor closed 2 months ago

daphnecor commented 1 year ago

Description This pull request adds two introduction tutorials. These tutorials are part of a series of four and are intended to help users get started with Nocturne.

[x] 01_data_structure.ipynb provides an introduction to the supported data structure used in Nocturne. It walks through a traffic scenario that is constructed from the Waymo dataset.
[x] 02_nocturne_concepts.ipynb covers the basic concepts in the Nocturne simulator.
[x] 03_imitation_learning.ipynb is based on the scripts in the imitation_learning folder and walks through a basic imitation learning setup in Nocturne.
[ ] 04_reinforcement_learning walks through a basic RL environment setup in Nocturne.

Thank you for considering this pull request. I hope that these tutorials will be useful to the Nocturne community and look forward to your feedback!

facebook-github-bot commented 1 year ago

Hi @daphnecor!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

eugenevinitsky commented 1 year ago

Hey Daphne, super excited about this! As discussed, could you convert these into jupytext notebooks? This makes it a lot easier to review and commit since it's plain markdown

daphnecor commented 1 year ago

Thank you @eugenevinitsky! I added Markdown versions of the notebook in commit 0a94e49.

Let me know if you would like me to remove the original .ipynb files.

eugenevinitsky commented 1 year ago

Hey Daphne, yes removing the notebooks would be great so that the commit is clean!

daphnecor commented 1 year ago

Alright! Integrated your feedback for tutorials 1 + 2, and just added number 3 on imitation learning.