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

Minor: Add documentation about memory use for ArrayData #3529

Merged
merged 6 commits into from
Jan 17, 2023

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Jan 14, 2023

Which issue does this PR close?

re #3407

Rationale for this change

Rationale is that I am always confused / have to remind myself what the various memory functions track. #3501 from @askoa (❤️ ) added a third so I felt it was time to document what was going on here better (with a diagram!)

What changes are included in this PR?

Add documentation about various memory functions on ArrayData

Are there any user-facing changes?

docstrings

@github-actions github-actions bot added the arrow Changes to the arrow crate label Jan 14, 2023
arrow-data/src/bitmap.rs Outdated Show resolved Hide resolved
arrow-data/src/data.rs Outdated Show resolved Hide resolved
arrow-data/src/data.rs Outdated Show resolved Hide resolved
arrow-data/src/data.rs Outdated Show resolved Hide resolved
arrow-data/src/data.rs Outdated Show resolved Hide resolved
arrow-data/src/data.rs Outdated Show resolved Hide resolved
arrow-data/src/data.rs Outdated Show resolved Hide resolved
Comment on lines 614 to 615
/// [ArrayData] pointing at the same underlying [`Buffer`]s with a
/// different offset, len and a shifted null bitmap.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
/// [ArrayData] pointing at the same underlying [`Buffer`]s with a
/// different offset, len and a shifted null bitmap.
/// [`ArrayData`] pointing at the same underlying [`Buffer`]s with a
/// different offset, len and a shifted null bitmap.

@@ -245,18 +245,58 @@ pub(crate) fn into_buffers(
/// An generic representation of Arrow array data which encapsulates common attributes and
/// operations for Arrow array. Specific operations for different arrays types (e.g.,
/// primitive, list, struct) are implemented in `Array`.
///
/// # Memory Layout
Copy link
Member

Choose a reason for hiding this comment

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

👍

arrow-data/src/data.rs Outdated Show resolved Hide resolved
arrow-data/src/data.rs Outdated Show resolved Hide resolved
arrow-data/src/data.rs Outdated Show resolved Hide resolved
arrow-data/src/data.rs Outdated Show resolved Hide resolved
arrow-data/src/data.rs Outdated Show resolved Hide resolved
alamb and others added 3 commits January 15, 2023 05:23
Co-authored-by: Liang-Chi Hsieh <[email protected]>
Co-authored-by: Raphael Taylor-Davies <[email protected]>
Co-authored-by: Raphael Taylor-Davies <[email protected]>
arrow-data/src/data.rs Outdated Show resolved Hide resolved
arrow-data/src/bitmap.rs Outdated Show resolved Hide resolved
Co-authored-by: Raphael Taylor-Davies <[email protected]>
@tustvold tustvold merged commit 14545a4 into apache:master Jan 17, 2023
@ursabot
Copy link

ursabot commented Jan 17, 2023

Benchmark runs are scheduled for baseline = c906fbf and contender = 14545a4. 14545a4 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ec2-t3-xlarge-us-east-2] ec2-t3-xlarge-us-east-2
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on test-mac-arm] test-mac-arm
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ursa-i9-9960x] ursa-i9-9960x
[Skipped ⚠️ Benchmarking of arrow-rs-commits is not supported on ursa-thinkcentre-m75q] ursa-thinkcentre-m75q
Buildkite builds:
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arrow Changes to the arrow crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants