Skip to content
This repository was archived by the owner on Jul 10, 2025. It is now read-only.

Commit 67c0e2a

Browse files
authored
Add information about documentation and tutorial.
1 parent d497090 commit 67c0e2a

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

rfcs/20200519-csr-sparse-matrix.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
| **RFC #** | 246 |
66
| **Author(s)** | Penporn Koanantakool ([email protected]) |
77
| **Sponsor** | Rasmus Larsen ([email protected]), Tatiana Shpeisman ([email protected])|
8-
| **Updated** | 2019-05-19 |
8+
| **Updated** | 2019-05-28 |
99

1010
## Objective
1111

@@ -136,6 +136,8 @@ CSRSparseMatrix is compatible with all platforms supported by TensorFlow.
136136

137137

138138
### Tutorials and Examples
139+
Once the implementation is complete, we plan to post a tutorial on the TensorFlow blog or the TensorFlow Tutorial section. All Python and C++ APIs will be documented on the TensorFlow website just like other TensorFlow ops.
140+
139141
The following snippet shows how CSRSparseMatrix can be used in Python.
140142
```Python
141143
import tf.linalg.experimental.sparse as csr
@@ -191,7 +193,7 @@ D_csr = csr.concat([A_csr, B_csr, C_csr], axis=1)
191193
* This design will conform to the backward and forward compatibility requirements once it is moved outside the experimental package. It only adds new functionalities without making changes to existing features.
192194
* How this proposal interacts with other parts of the TensorFlow Ecosystem:
193195
* TFLite: TFLite already supports the CSR format. TensorFlow should be able to pass the format to TFLite without problems.
194-
* Distribution strategies: Don’t plan on interacting with this in this initial phase. Could overlap with DTensor.
196+
* Distribution strategies: Don’t plan on interacting with this in this initial phase.
195197
* tf.function: Should work just like any other ops.
196198
* GPU: We plan to make all CSRSparseMatrix operations work on GPUs.
197199
* TPU: We don’t plan on supporting CSRSparseMatrix on TPUs yet.
@@ -283,7 +285,7 @@ The Python [CSRSparseMatrix](https://cs.opensource.google/tensorflow/tensorflow/
283285

284286

285287
### Shape Inference
286-
`Variant tensors` are perceived as scalars in TensorFlow. For proper shape inferences, we store `CSRSparseMatrix`’s shape and data type in a shape inference primitive, [ShapeAndType](https://cs.opensource.google/tensorflow/tensorflow/+/v2.2.0-rc4:tensorflow/core/framework/shape_inference.h;l=133), and access them through [input_handle_shapes_and_types](https://cs.opensource.google/tensorflow/tensorflow/+/v2.2.0-rc4:tensorflow/core/framework/shape_inference.h;l=584) and [set_output_handle_shapes_and_types](https://cs.opensource.google/tensorflow/tensorflow/+/v2.2.0-rc4:tensorflow/core/framework/shape_inference.h;l=588) during shape inference.
288+
`Variant` tensors are perceived as scalars in TensorFlow. For proper shape inference, we store `CSRSparseMatrix`’s shape and data type in a shape inference primitive, [ShapeAndType](https://cs.opensource.google/tensorflow/tensorflow/+/v2.2.0-rc4:tensorflow/core/framework/shape_inference.h;l=133), and access them through [input_handle_shapes_and_types](https://cs.opensource.google/tensorflow/tensorflow/+/v2.2.0-rc4:tensorflow/core/framework/shape_inference.h;l=584) and [set_output_handle_shapes_and_types](https://cs.opensource.google/tensorflow/tensorflow/+/v2.2.0-rc4:tensorflow/core/framework/shape_inference.h;l=588) during shape inference.
287289

288290

289291
### APIs

0 commit comments

Comments
 (0)