Skip to content

Commit f4807a7

Browse files
HasenpfoteHasenpfote
authored andcommitted
Change some descriptions
1 parent fa3b37e commit f4807a7

File tree

2 files changed

+122
-0
lines changed

2 files changed

+122
-0
lines changed

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -182,5 +182,61 @@ tracer.trace(
182182
```
183183
![usage2c](https://raw.githubusercontent.com/Hasenpfote/malloc_tracer/master/docs/usage2c.png)
184184

185+
**Displays related traces for each file.**
186+
```python
187+
import numpy as np
188+
from malloc_tracer.tracer import *
189+
190+
191+
global_var1 = None
192+
global_var2 = None
193+
194+
195+
def func2():
196+
global global_var1
197+
global global_var2
198+
global_var1 = np.empty((1000, ), dtype=np.float64)
199+
global_var2 = np.empty((10000, ), dtype=np.float64)
200+
201+
202+
def func(x, y, z):
203+
dataset1 = np.empty((100, ), dtype=np.float64)
204+
print('x', x)
205+
dataset1 = np.empty((1000, ), dtype=np.float64)
206+
207+
l = [i for i in range(100000)]
208+
209+
func2()
210+
211+
if x == 0:
212+
dataset4a = np.empty((100000, ), dtype=np.float64)
213+
return 0
214+
elif x == 1:
215+
dataset4b = np.empty((100000, ), dtype=np.float64)
216+
return 1
217+
218+
dataset3 = np.empty((3000, ), dtype=np.float64)
219+
return 2
220+
```
221+
222+
```python
223+
tracer = Tracer(func)
224+
tracer.trace(
225+
target_args=dict(x=1, y=2, z=3),
226+
related_traces_output_mode=RelatedTracesOutputMode.FOR_EACH_FILE
227+
)
228+
```
229+
![usage3a](https://raw.githubusercontent.com/Hasenpfote/malloc_tracer/master/docs/usage3a.png)
230+
231+
**Displays related traces in descending order.**
232+
```python
233+
tracer = Tracer(func)
234+
tracer.trace(
235+
target_args=dict(x=1, y=2, z=3),
236+
related_traces_output_mode=RelatedTracesOutputMode.IN_DESCENDING_ORDER
237+
)
238+
```
239+
![usage3b](https://raw.githubusercontent.com/Hasenpfote/malloc_tracer/master/docs/usage3b.png)
240+
185241
## License
186242
This software is released under the MIT License, see LICENSE.

README.rst

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,6 +213,72 @@ Usage
213213

214214
usage2c
215215

216+
**Displays related traces for each file.**
217+
218+
.. code:: python
219+
220+
import numpy as np
221+
from malloc_tracer.tracer import *
222+
223+
224+
global_var1 = None
225+
global_var2 = None
226+
227+
228+
def func2():
229+
global global_var1
230+
global global_var2
231+
global_var1 = np.empty((1000, ), dtype=np.float64)
232+
global_var2 = np.empty((10000, ), dtype=np.float64)
233+
234+
235+
def func(x, y, z):
236+
dataset1 = np.empty((100, ), dtype=np.float64)
237+
print('x', x)
238+
dataset1 = np.empty((1000, ), dtype=np.float64)
239+
240+
l = [i for i in range(100000)]
241+
242+
func2()
243+
244+
if x == 0:
245+
dataset4a = np.empty((100000, ), dtype=np.float64)
246+
return 0
247+
elif x == 1:
248+
dataset4b = np.empty((100000, ), dtype=np.float64)
249+
return 1
250+
251+
dataset3 = np.empty((3000, ), dtype=np.float64)
252+
return 2
253+
254+
.. code:: python
255+
256+
tracer = Tracer(func)
257+
tracer.trace(
258+
target_args=dict(x=1, y=2, z=3),
259+
related_traces_output_mode=RelatedTracesOutputMode.FOR_EACH_FILE
260+
)
261+
262+
.. figure:: https://raw.githubusercontent.com/Hasenpfote/malloc_tracer/master/docs/usage3a.png
263+
:alt: usage3a
264+
265+
usage3a
266+
267+
**Displays related traces in descending order.**
268+
269+
.. code:: python
270+
271+
tracer = Tracer(func)
272+
tracer.trace(
273+
target_args=dict(x=1, y=2, z=3),
274+
related_traces_output_mode=RelatedTracesOutputMode.IN_DESCENDING_ORDER
275+
)
276+
277+
.. figure:: https://raw.githubusercontent.com/Hasenpfote/malloc_tracer/master/docs/usage3b.png
278+
:alt: usage3b
279+
280+
usage3b
281+
216282
License
217283
-------
218284

0 commit comments

Comments
 (0)