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

Documentation update: add examples #406

Merged
merged 2 commits into from
Apr 17, 2024
Merged

Documentation update: add examples #406

merged 2 commits into from
Apr 17, 2024

Conversation

r1viollet
Copy link
Collaborator

@r1viollet r1viollet commented Apr 14, 2024

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
Copy link

pr-commenter bot commented Apr 14, 2024

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
Copy link

pr-commenter bot commented Apr 14, 2024

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

Readme.md Outdated Show resolved Hide resolved
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
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:]') && \

Readme.md Outdated Show resolved Hide resolved
@nsavoire
Copy link
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
2 checks passed
@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