Skip to content

Documentation update: add examples#406

Merged
r1viollet merged 2 commits into
mainfrom
r1viollet/doc-0.17.1
Apr 17, 2024
Merged

Documentation update: add examples#406
r1viollet merged 2 commits into
mainfrom
r1viollet/doc-0.17.1

Conversation

@r1viollet

@r1viollet r1viollet commented Apr 14, 2024

Copy link
Copy Markdown
Collaborator

What does this PR do?

  • Add examples
  • Simplify install commands

Motivation

Ease of use

Additional Notes

NA

How to test the change?

NA

- Add examples
- Simplify install commands
@pr-commenter

pr-commenter Bot commented Apr 14, 2024

Copy link
Copy Markdown

Benchmark results for collatz

Parameters

Baseline Candidate
config baseline candidate
profiler-version ddprof 0.17.1+9c8f0928.31877243 ddprof 0.17.1+aef90978.32342764

Summary

Found 0 performance improvements and 0 performance regressions! Performance is the same for 1 metrics, 0 unstable metrics.

See unchanged results
scenario Δ mean execution_time
scenario:ddprof -S bench-collatz --preset cpu_only collatz_runner.sh same

@pr-commenter

pr-commenter Bot commented Apr 14, 2024

Copy link
Copy Markdown

Benchmark results for BadBoggleSolver_run

Parameters

Baseline Candidate
config baseline candidate
profiler-version ddprof 0.17.1+9c8f0928.31877243 ddprof 0.17.1+aef90978.32342764

Summary

Found 0 performance improvements and 0 performance regressions! Performance is the same for 1 metrics, 0 unstable metrics.

See unchanged results
scenario Δ mean execution_time
scenario:ddprof -S bench-bad-boggle-solver BadBoggleSolver_run work 1000 same

Comment thread Readme.md Outdated
Comment thread Readme.md Outdated
```bash
# ARCH should hold amd64 or arm64
ARCH=$(dpkg --print-architecture) && \
tag_name=$(curl -s https://api.github.com/repos/DataDog/ddprof/releases/latest | jq -r '.tag_name[1:]') && \

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
tag_name=$(curl -s https://api.github.com/repos/DataDog/ddprof/releases/latest | jq -r '.tag_name[1:]') && \

Comment thread Readme.md Outdated
@nsavoire

Copy link
Copy Markdown
Collaborator

I am still a bit unsure about the naming of the non-compressed executables:
image

  • it might add some confusion about what should be downloaded
  • they are missing linux suffix

@r1viollet
r1viollet requested a review from nsavoire April 17, 2024 12:45
Remove th need for jq
@r1viollet
r1viollet merged commit 43a0207 into main Apr 17, 2024
@r1viollet
r1viollet deleted the r1viollet/doc-0.17.1 branch April 17, 2024 19:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants