Skip to content

Commit

Permalink
Add log_cleared to the common index (#2400)
Browse files Browse the repository at this point in the history
### What
Help users discover the `log_cleared` API by adding it to the index.

Resolves:
 - #2348

TODO:
- [ ] After merging, this change should be cherry-picked into
`release-0.6` branch and documentation should be re-deployed.

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [ ] I've included a screenshot or gif (if applicable)

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: {{ pr-build-summary }}

<!-- This comment will be replaced by a link to the documentation
preview -->
  • Loading branch information
jleibs authored Jun 13, 2023
1 parent c4a02dd commit 0e3c824
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions rerun_py/docs/gen_common_index.py
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,11 @@ class Section:
# "LogLevel", "LoggingHandler"
func_list=["log_text_entry"],
),
Section(
title="Clearing Entities",
module_summary=None,
func_list=["log_cleared"],
),
Section(
title="Helpers",
module_summary="script_helpers",
Expand Down

1 comment on commit 0e3c824

@github-actions
Copy link

Choose a reason for hiding this comment

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

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Rust Benchmark'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.25.

Benchmark suite Current: 0e3c824 Previous: c4a02dd Ratio
datastore/num_rows=1000/num_instances=1000/packed=false/latest_at/default 406 ns/iter (± 2) 305 ns/iter (± 5) 1.33
datastore/num_rows=1000/num_instances=1000/packed=false/latest_at_missing/primary/default 293 ns/iter (± 0) 226 ns/iter (± 0) 1.30
datastore/num_rows=1000/num_instances=1000/packed=false/latest_at_missing/secondaries/default 451 ns/iter (± 0) 344 ns/iter (± 0) 1.31
datastore/num_rows=1000/num_instances=1000/gc/default 2670058 ns/iter (± 65996) 1732938 ns/iter (± 3141) 1.54
mono_points_arrow/generate_message_bundles 36364883 ns/iter (± 1338055) 28625166 ns/iter (± 870724) 1.27
mono_points_arrow/decode_message_bundles 81774290 ns/iter (± 1719765) 60020338 ns/iter (± 960693) 1.36
mono_points_arrow_batched/generate_message_bundles 24937091 ns/iter (± 1063030) 18364083 ns/iter (± 113022) 1.36
mono_points_arrow_batched/generate_messages 5661572 ns/iter (± 142046) 3665298 ns/iter (± 15868) 1.54
mono_points_arrow_batched/encode_total 31991607 ns/iter (± 986096) 23575000 ns/iter (± 103094) 1.36
mono_points_arrow_batched/decode_log_msg 522606 ns/iter (± 1014) 304958 ns/iter (± 741) 1.71
mono_points_arrow_batched/decode_message_bundles 9555821 ns/iter (± 71276) 7475644 ns/iter (± 9504) 1.28
mono_points_arrow_batched/decode_total 10085359 ns/iter (± 92589) 7882410 ns/iter (± 11077) 1.28
batch_points_arrow/decode_log_msg 73084 ns/iter (± 210) 48660 ns/iter (± 87) 1.50
batch_points_arrow/decode_total 81285 ns/iter (± 235) 51718 ns/iter (± 145) 1.57
arrow_mono_points/insert 2864687800 ns/iter (± 14440396) 1802787649 ns/iter (± 9807612) 1.59
arrow_mono_points/query 1410013 ns/iter (± 8419) 945437 ns/iter (± 1531) 1.49
arrow_batch_points/query 17233 ns/iter (± 46) 12072 ns/iter (± 8) 1.43
arrow_batch_vecs/query 476478 ns/iter (± 743) 316710 ns/iter (± 265) 1.50

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

Please sign in to comment.