Skip to content

GH-34956: [Docs][Python] Add to docs the usage of the FixedShapeTensorType - #34957

Merged
AlenkaF merged 9 commits into
apache:mainfrom
AlenkaF:docs-tensor-type-binding
Apr 12, 2023
Merged

GH-34956: [Docs][Python] Add to docs the usage of the FixedShapeTensorType#34957
AlenkaF merged 9 commits into
apache:mainfrom
AlenkaF:docs-tensor-type-binding

Conversation

@AlenkaF

@AlenkaFAlenkaF commented Apr 7, 2023•
edited by github-actions Bot
Loading

Copy link
Copy Markdown
Member

Rationale for this change

This PR adds examples of the use of FixedShapeTensorTypeto the PyArrow user guide. Should be reviewed and merged after #34883 is done.

@github-actions

github-actionsBot commented Apr 7, 2023

Copy link
Copy Markdown

@github-actionsgithub-actionsBot added the awaiting review Awaiting review label Apr 7, 2023
This was referenced Apr 7, 2023
Closed
Merged
@AlenkaF
AlenkaF marked this pull request as ready for review April 11, 2023 12:35
@AlenkaF

AlenkaF commented Apr 11, 2023

Copy link
Copy Markdown
MemberAuthor

Screenshot 2023-04-11 at 14 33 25

rok
rok requested changes Apr 11, 2023
View reviewed changes

@rokrok left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just two nits.

Comment threaddocs/source/python/extending_types.rst Outdated
Comment threaddocs/source/python/extending_types.rst Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting change review Awaiting change review and removed awaiting review Awaiting review awaiting changes Awaiting changes labels Apr 11, 2023
rok
rok approved these changes Apr 11, 2023
View reviewed changes

@rokrok left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM!

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting change review Awaiting change review labels Apr 11, 2023
@AlenkaF

AlenkaF commented Apr 11, 2023

Copy link
Copy Markdown
MemberAuthor

I am currently adding some more text. Will probably have extra content ready tomorrow morning!

jorisvandenbossche
jorisvandenbossche reviewed Apr 12, 2023
View reviewed changes

@jorisvandenbosschejorisvandenbossche left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Looks good! Some small comments.

I understand that we initially added this to extending_types.rst (when it was an example of implementing it). But now this is actually part of pyarrow, I am wondering if we would want to move it to a different location in our docs.
Currently, other data types are mentioned at https://arrow.apache.org/docs/dev/python/data.html, but that's already a long page about a lot of things, so also wouldn't just add it there. Maybe for now we can keep it here, and can think about reorganizing it later.

Comment threaddocs/source/python/extending_types.rst Outdated
Comment threaddocs/source/python/extending_types.rst Outdated
Comment threaddocs/source/python/extending_types.rst Outdated
@github-actionsgithub-actionsBot added awaiting changes Awaiting changes awaiting review Awaiting review and removed awaiting merge Awaiting merge awaiting review Awaiting review awaiting changes Awaiting changes labels Apr 12, 2023
@AlenkaF
AlenkaFforce-pushed the docs-tensor-type-binding branch from 4ca6485 to b3e3a57CompareApril 12, 2023 07:35
@AlenkaF

AlenkaF commented Apr 12, 2023

Copy link
Copy Markdown
MemberAuthor

I understand that we initially added this to extending_types.rst (when it was an example of implementing it). But now this is actually part of pyarrow, I am wondering if we would want to move it to a different location in our docs.
Currently, other data types are mentioned at https://arrow.apache.org/docs/dev/python/data.html, but that's already a long page about a lot of things, so also wouldn't just add it there. Maybe for now we can keep it here, and can think about reorganizing it later.

I will open an issue for this as I agree it should be reorganised (and I just remembered we have talked about this before, sorry).

Otherwise I have included the changes with the last two commits.

@github-actionsgithub-actionsBot added awaiting merge Awaiting merge and removed awaiting review Awaiting review labels Apr 12, 2023
@AlenkaF
AlenkaF merged commit b8427d3 into apache:mainApr 12, 2023
@AlenkaF
AlenkaF deleted the docs-tensor-type-binding branch April 12, 2023 08:38
@AlenkaF

AlenkaF commented Apr 12, 2023

Copy link
Copy Markdown
MemberAuthor

Thank you Joris and Rok for reviews!
The issue to rearrange Data Types user guide section can be found here: #35064

@ursabot

ursabot commented Apr 13, 2023

Copy link
Copy Markdown

Benchmark runs are scheduled for baseline = 07642fd and contender = b8427d3. b8427d3 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Failed] test-mac-arm
[Finished ⬇️4.59% ⬆️1.79%] ursa-i9-9960x
[Finished ⬇️0.77% ⬆️0.0%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] b8427d39 ec2-t3-xlarge-us-east-2
[Failed] b8427d39 test-mac-arm
[Finished] b8427d39 ursa-i9-9960x
[Finished] b8427d39 ursa-thinkcentre-m75q
[Finished] 07642fd5 ec2-t3-xlarge-us-east-2
[Failed] 07642fd5 test-mac-arm
[Finished] 07642fd5 ursa-i9-9960x
[Finished] 07642fd5 ursa-thinkcentre-m75q
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

@ursabot

ursabot commented Apr 13, 2023

Copy link
Copy Markdown

['Python', 'R'] benchmarks have high level of regressions.
ursa-i9-9960x

liujiacheng777 pushed a commit to LoongArch-Python/arrow that referenced this pull request May 11, 2023
@AlenkaF@rok@liujiacheng777
apacheGH-34956: [Docs][Python] Add to docs the usage of the FixedShap…
f13cd05
…eTensorType (apache#34957)
### Rationale for this change
This PR adds examples of the use of `FixedShapeTensorType`to the PyArrow user guide. Should be reviewed and merged after apache#34883 is done.
* Closes: apache#34956
Lead-authored-by: Alenka Frim <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Rok Mihevc <rok@mihevc.org>
Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
ArgusLi pushed a commit to Bit-Quill/arrow that referenced this pull request May 15, 2023
@AlenkaF@rok@ArgusLi
apacheGH-34956: [Docs][Python] Add to docs the usage of the FixedShap…
384a42d
…eTensorType (apache#34957)
### Rationale for this change
This PR adds examples of the use of `FixedShapeTensorType`to the PyArrow user guide. Should be reviewed and merged after apache#34883 is done.
* Closes: apache#34956
Lead-authored-by: Alenka Frim <frim.alenka@gmail.com>
Co-authored-by: Alenka Frim <AlenkaF@users.noreply.github.com>
Co-authored-by: Rok Mihevc <rok@mihevc.org>
Signed-off-by: Alenka Frim <frim.alenka@gmail.com>
@tadejatadeja mentioned this pull request Mar 3, 2026
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rokrokrok approved these changes
@jorisvandenbosschejorisvandenbosschejorisvandenbossche approved these changes

Assignees

No one assigned

Labels

awaiting mergeAwaiting mergeComponent: Documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[Docs][Python] Add to docs the usage of the FixedShapeTensorType

4 participants

@AlenkaF@ursabot@rok@jorisvandenbossche