huawei-noah/SMARTS

Add documented Jupyter Notebook examples

Open

#1,163 opened on Dec 8, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (220 forks)auto 404
documentationenhancementgood first issuerelease critical

Repository metrics

Stars
 (1,129 stars)
PR merge metrics
 (PR metrics pending)

Description

Is your feature request related to a problem? Please describe. With the scalability of SMARTS we need a clear way to describe the use cases and assembly of a SMARTS experiment.

Describe the solution you'd like Add notebook examples that can interleave documentation with example code. This also will feed into another issue for providing a support of use of SMARTS with Google Colab to allow for a quick demonstration of SMARTS.

Describe alternatives you've considered N/A

Additional context This need is seen from review of the presentation of other AD tools which use documented notebooks that can easily be opened with Google Colab. (e.g eleurent/highway-env, DriverGym)

Contributor guide

Research direction
Create Jupyter notebook examples that demonstrate SMARTS use cases, following the structure of existing notebooks in similar projects. Include markdown cells for documentation and code cells for running experiments. Ensure compatibility with Google Colab by adding setup cells.
Tech stack
python
Domain
documentationaiautonomous driving
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPythonJupyter Notebook
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85