Comment that data of THStorage may be NULL.

Signed-off-by: Edward Z. Yang <ezyang@fb.com>
zhouyonglong · Jul 20, 2017 · 4794230 · 4794230
1 parent 6b69723
commit 4794230
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/torch/csrc/README.md b/torch/csrc/README.md
@@ -30,6 +30,11 @@ One important case where this assumption is important is when tracking
 the CUDA device a tensor is stored in: this information is stored
 solely in the storage, so if a storage is NULL, we lose this information.
 
+Although storage is never NULL, the data field of THStorage may be NULL.  This
+mostly occurs when we want to pre-allocate an output tensor struct, but then
+have it be resized and filled with data by some operator: there's no point in
+allocating data for it in this case!
+
 ## Files
 
 ### `Exceptions.h`