-
Notifications
You must be signed in to change notification settings - Fork 12
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
Tutorial on Profiling Software Execution #775
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great, please keep it up! Just a few suggestions as you're working toward this.
@@ -0,0 +1,94 @@ | |||
# Profiling | |||
|
|||
Profiling is essential for assessing how different parts of a program execute and gathering crucial performance data. It plays a vital role in debugging, pinpointing bottlenecks, optimizing code, and scaling application performance. This analysis identifies common issues such as out-of-bound memory, segmentation faults, bus errors, and runtime overhead, enabling effective troubleshooting and improvement strategies. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please define some of these terms.
- out-of-bounds memory
- segmentation fault
- bus error
- runtime
- bottleneck
2. Memory Profling | ||
3. CPU Profling | ||
|
||
!!! note |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure to fix this admonition, it doesn't appear to be formatted correctly.
|
||
## Profiling Python Codes | ||
|
||
Three common profiling techniques used in analyzing Python codes are discussed briefly in this section. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In a short paragraph, give the purpose for each. Why would I want to use time vs CPU vs memory profiling?
|
||
The following example shows profiling a input python code that calculates num_array. | ||
|
||
```bash |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Change to python
Pull Request
A tutorial on Profiling software execution.
Overview
This tutorial page introduces various profiling techniques for analyzing software execution, with a focus on analyzing Python-based code.
Proposed Changes
Related Issues
Partial fix of #504