[Documentation]: Document Tensor operations that move the Tensor off the symmetric heap
Open
Nobody has claimed this yet.
documentation
iris
- Dominant language
- Python
- Stars
- 202
- Forks
- 47
- Avg merge
- 6d 11h
- Merged PRs (30d)
- 4
Description
Description of errors
There are PyTorch tensor ops that reallocate the Tensor and hence the Tensor becomes outside of the symmetric heap. We need to document these and possibly offer alternative APIs. For instance:
shmem = iris.iris()
tensor = shmem.zeros(4, 3) # On symmetric heap
non_contiguous = tensor[::2] # Non-contiguous slice
reshaped = non_contiguous.reshape(-1) # Creates copy off heap!
Attach any links, screenshots, or additional evidence you think will be helpful.
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the Python APIs shown in the issue: iris.iris(), shmem.zeros(), tensor slicing, and reshape(). Identify tensor operations that reallocate data outside the symmetric heap, then document those cases and any available alternatives. Done means users can recognize these operations and avoid unintentionally leaving the heap.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, pytorch
- Domain
- distributed-systems, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100