Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
PythonFZ committed Dec 15, 2022
1 parent d8fa4d1 commit 9691368
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion zntrack/core/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -685,7 +685,8 @@ def operating_directory(
prefix: str, default = 'ckpt'
Prefix for the temporary directory
remove_on: Exception or list of Exceptions, default = None
If a given exception is raised, the temporary directory will be removed.
If one of the exceptions in 'remove_on' is raised, the operating directory
will be removed. Otherwise, it will remain and reused upton the next run.
Yields
Expand Down

3 comments on commit 9691368

@github-actions
Copy link

Choose a reason for hiding this comment

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

Report for Python 3.9

name min max mean stddev median iqr outliers ops rounds iterations
0 tests/benchmark/test_benchmark.py::test_NodeCollector_run_and_save 0.000309002 0.211813 0.00495011 0.0311782 0.000316253 3.57e-05 1;6 202.016 46 1
1 tests/benchmark/test_benchmark.py::test_InputOutput_load_lazy 0.00104321 0.00866357 0.00111227 0.000563263 0.00105781 2.23757e-05 2;13 899.062 305 1
2 tests/benchmark/test_benchmark.py::test_InputOutput_load 0.00104621 0.00120041 0.00107409 2.2787e-05 0.00106836 2.57e-05 51;8 931.024 258 1
3 tests/benchmark/test_benchmark.py::test_InputOutput_write_graph 0.00145361 0.00324459 0.00150888 0.00012199 0.00148981 3.7851e-05 7;18 662.745 273 1
4 tests/benchmark/test_benchmark.py::test_InputOutput_run_and_save 0.00150591 0.00192702 0.00157489 6.10878e-05 0.00155756 5.73e-05 60;16 634.963 340 1
5 tests/benchmark/test_benchmark.py::test_NodeCollector_load_lazy 0.00176501 0.0102942 0.00193414 0.000953327 0.00180311 3.48e-05 4;14 517.026 241 1
6 tests/benchmark/test_benchmark.py::test_NodeCollector_load 0.00177001 0.0113637 0.0018741 0.00075409 0.00180701 3.57257e-05 1;5 533.589 161 1
7 tests/benchmark/test_benchmark.py::test_NodeCollector_write_graph 0.188028 0.374939 0.245907 0.0747796 0.220127 0.074281 1;0 4.06658 5 1

@github-actions
Copy link

Choose a reason for hiding this comment

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

Report for Python 3.10

name min max mean stddev median iqr outliers ops rounds iterations
0 tests/benchmark/test_benchmark.py::test_NodeCollector_run_and_save 0.000350804 0.000744408 0.000403866 9.70026e-05 0.000372104 2.50005e-05 4;5 2476.07 44 1
1 tests/benchmark/test_benchmark.py::test_InputOutput_load_lazy 0.00087431 0.0105198 0.00109828 0.00057292 0.00107461 7.9351e-05 1;6 910.513 275 1
2 tests/benchmark/test_benchmark.py::test_InputOutput_load 0.000874389 0.0109341 0.00113068 0.000657253 0.00108919 4.52995e-05 2;13 884.42 276 1
3 tests/benchmark/test_benchmark.py::test_NodeCollector_load_lazy 0.00145072 0.00999002 0.00177074 0.00070601 0.00170322 0.000117327 2;13 564.737 217 1
4 tests/benchmark/test_benchmark.py::test_NodeCollector_load 0.00145103 0.0135311 0.00177626 0.000905576 0.00169333 0.000134778 2;5 562.982 205 1
5 tests/benchmark/test_benchmark.py::test_InputOutput_write_graph 0.00159762 0.0889133 0.00202246 0.00460098 0.00174862 6.97765e-05 1;37 494.447 359 1
6 tests/benchmark/test_benchmark.py::test_InputOutput_run_and_save 0.00178582 0.0384187 0.00204963 0.00205339 0.00190292 5.26758e-05 1;46 487.894 317 1
7 tests/benchmark/test_benchmark.py::test_NodeCollector_write_graph 0.164187 0.486716 0.253851 0.118315 0.217693 0.0582653 1;1 3.93932 6 1

@github-actions
Copy link

Choose a reason for hiding this comment

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

Report for Python 3.8

name min max mean stddev median iqr outliers ops rounds iterations
0 tests/benchmark/test_benchmark.py::test_NodeCollector_run_and_save 0.000409002 0.00975466 0.000732954 0.00149287 0.000417202 3.12005e-05 2;5 1364.34 44 1
1 tests/benchmark/test_benchmark.py::test_InputOutput_load_lazy 0.00127961 0.00276542 0.00137393 0.000157888 0.00133741 8.93502e-05 17;19 727.838 243 1
2 tests/benchmark/test_benchmark.py::test_InputOutput_load 0.00129171 0.00716034 0.00139466 0.000407551 0.00132551 6.39248e-05 7;21 717.019 247 1
3 tests/benchmark/test_benchmark.py::test_InputOutput_write_graph 0.00196711 0.00993626 0.00233354 0.000637389 0.00223981 0.000371653 10;10 428.534 305 1
4 tests/benchmark/test_benchmark.py::test_NodeCollector_load 0.00201931 0.0120539 0.00232948 0.000741684 0.00220051 0.000128901 7;21 429.281 226 1
5 tests/benchmark/test_benchmark.py::test_InputOutput_run_and_save 0.00207091 0.0931678 0.00399414 0.0104468 0.00229047 0.000322803 5;38 250.367 282 1
6 tests/benchmark/test_benchmark.py::test_NodeCollector_load_lazy 0.00208771 0.0153084 0.00242559 0.00103493 0.00222681 0.000127201 7;26 412.27 219 1
7 tests/benchmark/test_benchmark.py::test_NodeCollector_write_graph 0.261276 0.380731 0.323 0.0528056 0.341182 0.0933242 2;0 3.09598 5 1

Please sign in to comment.