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

Update docs for qualification tool to reflect recommendations and UI [skip ci] #5701

Merged
merged 4 commits into from
Jun 3, 2022

Conversation

amahussein
Copy link
Collaborator

Signed-off-by: Ahmed Hussein (amahussein) a@ahussein.me

fixes #5543

Changes:

  • Describe GPU Recommendation
    • Remove Score algorithm
    • Describe how the estimated fields are calculated.
  • Update the CLI arguments
  • Update the output description of the tool
    • Update the fields and add new output files
    • Add section to describe HTML Report
    • Add screenshot of the HTML under /docs/img/Tools

@amahussein amahussein added documentation Improvements or additions to documentation tools labels May 31, 2022
@amahussein amahussein added this to the May 23 - Jun 3 milestone May 31, 2022
@amahussein amahussein self-assigned this May 31, 2022
Signed-off-by: Ahmed Hussein (amahussein) <a@ahussein.me>

add screenShot to qualification docs

Signed-off-by: Ahmed Hussein (amahussein) <a@ahussein.me>

add more details to the tool descriptions

Signed-off-by: Ahmed Hussein (amahussein) <a@ahussein.me>
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
Signed-off-by: Ahmed Hussein (amahussein) <a@ahussein.me>
Signed-off-by: Ahmed Hussein (amahussein) <a@ahussein.me>
@amahussein amahussein marked this pull request as ready for review May 31, 2022 21:29
@amahussein amahussein changed the title WIP. Update docs for qualification tool to reflect recommendations and UI [skip ci] Update docs for qualification tool to reflect recommendations and UI [skip ci] May 31, 2022
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
docs/spark-qualification-tool.md Outdated Show resolved Hide resolved
@tgravescs
Copy link
Collaborator

would be good to get a new set of eyes on it as well @viadea @mattahrens

Signed-off-by: Ahmed Hussein (amahussein) <a@ahussein.me>
@tgravescs
Copy link
Collaborator

build

@tgravescs
Copy link
Collaborator

I'm going to merge this and lets review with others before release and we can tweak is necessary.

@tgravescs tgravescs merged commit 396763b into NVIDIA:branch-22.06 Jun 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation tools
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Update docs for qualification tool to reflect recommendations and UI
3 participants