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

Fix node docstring and add additional information #307

Merged
merged 1 commit into from
Oct 16, 2024

Conversation

kayjan
Copy link
Owner

@kayjan kayjan commented Oct 16, 2024

Description

Node name should not coincide with sep symbol - added docstring information.

Testing

Additional notes

Checklist

I have read through the contributing guidelines and ensured that

  • I have added a descriptive title for this pull request.
  • I have followed the convention and standards, and my code is checked for style and correctness.
  • I have added test cases, and unit tests pass with 100% code coverage.
  • I have updated the documentation and code docstrings.

Checklist (for reviewer)

  • I have added label (breaking / enhancement / bug / documentation) to this pull request, if applicable.
  • I will ensure this change is captured in the CHANGELOG.md file.

@kayjan kayjan added the documentation Improvements or additions to documentation label Oct 16, 2024
Copy link
Contributor

Code Coverage

Package Line Rate Branch Rate Complexity Health
bigtree 100% 100% 0
bigtree.binarytree 100% 100% 0
bigtree.dag 100% 100% 0
bigtree.node 100% 100% 0
bigtree.tree 100% 100% 0
bigtree.utils 100% 100% 0
Summary 100% (2349 / 2349) 100% (990 / 990) 0

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Benchmark

Benchmark suite Current: fff2aa3 Previous: 384a07e Ratio
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10 15298.21576921385 iter/sec (stddev: 0.000020008010638209235) 12024.281834680844 iter/sec (stddev: 0.00004066945865196257) 0.79
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100 706.6417683802499 iter/sec (stddev: 0.00003483957537232593) 713.1499211578733 iter/sec (stddev: 0.00002847222022880613) 1.01
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000 12.256250321048622 iter/sec (stddev: 0.0038222785043383048) 12.406327274301638 iter/sec (stddev: 0.0031283895287921295) 1.01
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10 67.0927120977536 iter/sec (stddev: 0.003998124859241916) 70.3489375894473 iter/sec (stddev: 0.0034139032664167496) 1.05
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_10_no_assertions 22071.25483879563 iter/sec (stddev: 0.0000031773136097002063) 23344.495893724637 iter/sec (stddev: 0.000002041770830545473) 1.06
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_100_no_assertions 1588.4785742849506 iter/sec (stddev: 0.00009828331710421792) 1695.7903107740099 iter/sec (stddev: 0.000045253066229889915) 1.07
tests/node/test_node_benchmark.py::test_node_benchmark_width_1_depth_1000_no_assertions 110.1607803749959 iter/sec (stddev: 0.003881674625425511) 101.99168339414823 iter/sec (stddev: 0.0048215511301963505) 0.93
tests/node/test_node_benchmark.py::test_node_benchmark_width_2_depth_10_no_assertions 89.88116173450466 iter/sec (stddev: 0.003907271395932626) 96.55530733870081 iter/sec (stddev: 0.0029105622442837215) 1.07

This comment was automatically generated by workflow using github-action-benchmark.

@kayjan kayjan merged commit c1c55a9 into master Oct 16, 2024
6 checks passed
@kayjan kayjan deleted the bugfix/docstring-node branch October 16, 2024 14:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant