GH-43352: [Docs][Python] Add all tensor classes documentation#45160
GH-43352: [Docs][Python] Add all tensor classes documentation#45160ShaiviAgarwal2 wants to merge 8 commits intoapache:mainfrom
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
|
@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:
|
|
@ShaiviAgarwal2 if it would be easier you can also start fresh and create a new PR from latest main in favour of this one? |
Okk |
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, andSparseCSFTensorclasses and their methods in thetensor.pxifile.tables.rstfile to include documentation forSparseCSFTensoralong 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.