Refactored readme documentation for Gaudi examples #721
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Supriya-Krishnamurthi
force-pushed
the
hpu_documentation
branch
2 times, most recently
from
95b7533
to
eea7857
Compare
Supriya-Krishnamurthi
force-pushed
the
hpu_documentation
branch
2 times, most recently
from
b2ccb9a
to
e047796
Compare
bharagha
reviewed
Feb 3, 2023
| # PyTorch_Kvasir_UNet | ||
|
|
||
| ## **Habana Tutorials** | ||
| #### The name of the file/example that contain HPU adaptations start with "HPU". |
There was a problem hiding this comment.
Given the name change, check HPU here.
Also is the comment valid?
| Please follow the instructions provided in the [Gaudi Installation Guide](https://docs.habana.ai/en/latest/Installation_Guide/index.html) to set up the environment including the ```$PYTHON``` environment variable. | ||
| <br/> | ||
|
|
||
| This example was tested on AWS DL1 EC2 instance created by following the instructions mentioned [here](https://docs.habana.ai/en/latest/AWS_EC2_DL1_and_PyTorch_Quick_Start/AWS_EC2_DL1_and_PyTorch_Quick_Start.html) . |
There was a problem hiding this comment.
Add a note: :"The example can be executed on any Gaudi configuration, DL1 on AWS or on an on-prem configuration. Currently, the validation has only been done on DL1 instance on AWS".
|
|
||
| ### **Note**: | ||
|
|
||
| **There is a dependency in the order of execution (moving model to HPU and intializing optimizer). The workaround is to execute this step before initializing any optimizers.** |
There was a problem hiding this comment.
"execute this step". Instead say, "execute the below step".
| ## **Habana Tutorials** | ||
|
|
||
| ## **About model and experiments** | ||
|
|
There was a problem hiding this comment.
Apply my comments from the Kvasir documentation review.
|
|
||
| **Note:** By default these experiments utilize only 1 HPU device | ||
| <br/> | ||
|
|
There was a problem hiding this comment.
Comments from previous readme review are applicable here. Please apply them.
Supriya-Krishnamurthi
force-pushed
the
hpu_documentation
branch
from
e047796
to
8213287
Compare
ytang-habana
approved these changes
Feb 11, 2023
Signed-off-by: Supriya Krishnamurthi <[email protected]>
Supriya-Krishnamurthi
force-pushed
the
hpu_documentation
branch
from
8213287
to
54c1d71
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following changes suggested by Habana team: