Skip to content

Fix: documentation problems #882

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.

Sign up for GitHub

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

Merged
belletva merged 1 commit into from
Apr 16, 2026
Merged

Fix: documentation problems #882

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/source/profiling.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,15 +60,15 @@ Currently, some processes are already profiled by GeoUtils with a memory consump

### Modifying the profiled functions

To profile other functions and add them to the summary graphs and data, simply add the *@profile_tool* decorator before them, providing a descriptive name.
To profile other functions and add them to the summary graphs and data, simply add the *@profile* decorator before them, providing a descriptive name.

If you also want to track memory usage over time for a specific function call, set `memprof=True` in the decorator.
If the function is too fast (or slow) for the default memory sampling interval, you can modify it with *interval* (in seconds).

```{code-cell} ipython3
from geoutils import profiler
from geoutils.profiler import profile

@profiler.profile("my profiled function name", memprof=True, interval=0.5) # type: ignore
@profile("my profiled function name", memprof=True, interval=0.5) # type: ignore
def my_function():
...
```
Expand All @@ -84,7 +84,7 @@ def my_function():

Here are two examples of graphs with a personal profiled function `my_program`, containing the computation of a few attributes and a co-registration:

![memory_my_program.html](imgs/profiling_memory_my_program.html.png)
![time_graph.html](imgs/profilingprofiling_time_graph.html.png)
![memory_my_program.html](imgs/profiling_memory_my_program.png)
![time_graph.html](imgs/profiling_time_graph.png)

You can experiment with these graphs here : [memory_my_program.html](html/profiling/memory_my_program.html) and [time_graph.html](html/profiling/time_graph.html).
Loading