tensordict
tensordict copied to clipboard
[Feature] Add free threading support
Description
This change removes a race condition in value caching that causes segfaults in python under free threading.
Additionally, it adds a declaration that the library does not use the GIL.
Motivation and Context
tensordict segfaults with this script on py3.14t with PYTHON_GIL=0.
import sys
import gc
import threading
import torch
from tensordict import TensorDict
def gc_stress():
for _ in range(100):
td = TensorDict(
{"a": torch.randn(5, 5), "b": {"c": torch.randn(5, 3)}}, batch_size=[5]
)
td = None
gc.collect()
def main():
print(f"Python version: {sys.version}")
if hasattr(sys, "_is_gil_enabled"):
print(f"GIL enabled: {sys._is_gil_enabled()}")
else:
print("GIL status: N/A (not a free-threading build)")
threads = [threading.Thread(target=gc_stress) for _ in range(8)]
for t in threads:
t.start()
for t in threads:
t.join()
print("Done - no crash!")
if __name__ == "__main__":
main()
I can put this in a test if you'd like. It's more of a regression test than a unit test.
- [ ] I have raised an issue to propose this change (required for new features and bug fixes)
Types of changes
What types of changes does your code introduce? Remove all that do not apply:
- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds core functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
- [ ] Documentation (update in the documentation)
- [ ] Example (update in the folder of examples)
Checklist
Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!
- [x] I have read the CONTRIBUTION guide (required)
- [ ] My change requires a change to the documentation.
- [ ] I have updated the tests accordingly (required for a bug fix or a new feature).
- [ ] I have updated the documentation accordingly.
Hi @kevmo314!
Thank you for your pull request and welcome to our community.
Action Required
In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.
Process
In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.
Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.
If you have received this in error or have any questions, please contact us at [email protected]. Thanks!
I've signed the CLA.