Adding placeholder notebooks for detailed tutorials #141
Conversation
These are notebook placeholders for developers to try it out.
Updated the README to provide a clearer overview of the tutorials, including prerequisites and installation instructions. Added a list of notebooks with descriptions for better navigation.
Removed data collection details from the tutorial README.
|
moved all the notebooks to tutorials directory and updated README. |
There was a problem hiding this comment.
would it be possible to use the banner here to avoid duplication?
https://github.com/openvinotoolkit/physicalai/blob/main/docs/assets/physicalai.png
There was a problem hiding this comment.
Radwan asked to change this one, with the OpenVINO Physical AI
There was a problem hiding this comment.
would it be possible to have the raw files like svg, so we could modify them later if needed?
.png files cannot be modified
There was a problem hiding this comment.
would it be possible to have consistent filename extensions?
There was a problem hiding this comment.
and same comment as above regarding raw files
There was a problem hiding this comment.
also would it be possible to follow a consistent design theme. For example standardized arrows, colors, box shapes with fixed radius (rectangle vs ellipse) etc
There was a problem hiding this comment.
also, big arrows are a bit large and not well aligned.
similar to above, raw files would be great to modify them
There was a problem hiding this comment.
the boxes in this figure are not consistent with the rest of the figures. would be great to follow the same style in terms of consistency
There was a problem hiding this comment.
would it be possible to use snake_case naming convention please?
There was a problem hiding this comment.
would it be possible to use snake_case naming convention?
There was a problem hiding this comment.
would it be possible to use snake_case naming convention please?
There was a problem hiding this comment.
examples/tutorials/media/download-model.png file uses red bounding box around the button. To follow the same convention, it would be great if this also has a bounding box. or vice-versa?
There was a problem hiding this comment.
similar to the above naming conventions, it would be great to follow snake_case naming convention for this, and the rest of the jupyter notebooks.
so something like 001_introduction.ipynb
| **Getting Started** | ||
| ```bash | ||
| pip install "physicalai[so101,capture]" physicalai-train | ||
| pip install jupyter # if jupyter notebook is not already installed |
There was a problem hiding this comment.
can you add jupyter here like
notebooks = ["matplotlib", "matplotlib-inline", "ipykernel", "jupyter"]Line 41 in 9995024
so this way, users can run pip install physicalai[capture,so101,jupyter]
it's cleaner
| ```bash | ||
| pip install "physicalai[so101,capture]" physicalai-train | ||
| pip install jupyter # if jupyter notebook is not already installed | ||
| phython -m venv venv |
There was a problem hiding this comment.
there is a typo here. also, if we really want users to install from source, not pypi, uv could also be an option.
There was a problem hiding this comment.
this requirements.txt file is not needed, and actually we should not have these to avoid inconsistent behaviour. they should follow the official installation guidelines from pyproject.toml file
samet-akcay
left a comment
samet-akcay
left a comment
There was a problem hiding this comment.
we could temporarily merge these to main. However, we will need to work on this content to further polish
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| snapshot_download( | ||
| repo_id=repo_id, |
| snapshot_download( | ||
| repo_id=repo_id, |
| hf_hub_download( | ||
| repo_id=repo_id, |
There was a problem hiding this comment.
@amul1umt CI checks are failing. Would you like to address them, or would you want me to address them?
I could address them by merging this pr into docs/tutorial branch and work on it ? Which one would you prefer ?
samet-akcay
merged commit 6f764b8
into
openvinotoolkit:docs/tutorials
4 participants
Summary
Placeholder notebooks for detailed tutorials upcoming for developers to try it out
Why
Easy starting guides for developers using SO101 robot
Validation
Breaking changes
Related issues