-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
GH-43352: [Docs][Python] Add all tensor classes documentation #45160
base: main
Are you sure you want to change the base?
GH-43352: [Docs][Python] Add all tensor classes documentation #45160
Conversation
### Rationale for this change We have added the missing documentation for various tensor classes in PyArrow, specifically `SparseCOOTensor`, `SparseCSRMatrix`, `SparseCSCMatrix`, and `SparseCSFTensor`. This documentation is necessary to provide users with reference information and examples on how to use these classes, as currently, there is no reference documentation or information in the PyArrow user guide regarding these tensor classes. ### What changes are included in this PR? 1. Added docstrings to the `SparseCSRMatrix`, `SparseCSCMatrix`, and `SparseCSFTensor` classes and their methods in the `tensor.pxi` file. 2. Updated the `tables.rst` file to include documentation for `SparseCSFTensor` along with examples. ### Are these changes tested? No new tests are included in this PR as the changes are purely documentation updates. The existing tests for the tensor classes should cover the functionality. ### Are there any user-facing changes? Yes, the user-facing change is the addition of documentation for the tensor classes, which will help users understand and utilize these classes more effectively. There are no breaking changes to public APIs.
|
@github-actions crossbow submit preview-docs |
Revision: 59e8197 Submitted crossbow builds: ursacomputing/crossbow @ actions-8a25ed4ca3
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are some style corrections needed - I think @kou added all but they are marked as resolved - maybe we are missing a commit?
I also added some comments regarding the code blocks and docstrings.
@AlenkaF Yes I marked as resolved but didn't submit the new commit as working on some checks that are failing |
@kou Could you please help me to resolve the conflicts caused!! |
Hmm. What It may be better that you create a new branch and open a new PR from it. |
I use these commands inorder to resolve the conflicts but they didn't work !! git checkout master |
Ok will now create a new branch and submit a new pr from it! |
Is this correct? It seems that your fork doesn't have |
Yes i used |
Yes. If BTW, it seems that your main https://github.com/ShaiviAgarwal2/arrow is too old:
|
Rationale for this change
We have added the missing documentation for various tensor classes in PyArrow, specifically
SparseCOOTensor
,SparseCSRMatrix
,SparseCSCMatrix
, andSparseCSFTensor
. This documentation is necessary to provide users with reference information and examples on how to use these classes, as currently, there is no reference documentation or information in the PyArrow user guide regarding these tensor classes.What changes are included in this PR?
SparseCSRMatrix
,SparseCSCMatrix
, andSparseCSFTensor
classes and their methods in thetensor.pxi
file.tables.rst
file to include documentation forSparseCSFTensor
along with examples.Are these changes tested?
No new tests are included in this PR as the changes are purely documentation updates. The existing tests for the tensor classes should cover the functionality.
Are there any user-facing changes?
Yes, the user-facing change is the addition of documentation for the tensor classes, which will help users understand and utilize these classes more effectively. There are no breaking changes to public APIs.