Docs: operations cookbook (memory, coordinate manager, DDP, torch.compile, determinism) - #15
Merged
Merged
Conversation
…pile, determinism) Add docs/operations.md covering recurring production/training pain points mined from upstream and downstream issues: - Memory management with varying point counts (empty_cache interval, OOM-leak restartable-subprocess pattern from NVIDIA#359) - Coordinate-manager lifecycle (clear_global_coordinate_manager under SHARE_COORDINATE_MANAGER mode) - Multi-GPU DDP recipe (DataParallel unsupported per NVIDIA#264, torchrun launch, find_unused_parameters, pickling fix from PR NVIDIA#139) - torch.compile/Dynamo incompatibility (opaque C++ autograd handles, _dynamo.disable workaround) - Determinism (CPU vs GPU quantization per NVIDIA#441, atomic-add conv variation per NVIDIA#554, manual coord-sort workaround, planned built-in option) - ME_LAZY_SYNC single-stream safety callout Register in docs/index.rst toctree; link from README.md after the performance-guide link.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/operations.md: a practical "running ME in production/training" cookbook covering the recurring pain points mined from ~250 upstream and downstream issuesdocs/index.rsttoctree (Miscellanea section, after the performance guide)README.mdbelow the existing performance-guide paragraphSections
torch.cuda.empty_cache()on an interval; the OOM-leak caveat from CUDA OOM error leads to GPU memory leak NVIDIA/MinkowskiEngine#359 (C++-side OOM strands GPU memory; restartable subprocess loop for unattended training)ME.clear_global_coordinate_manager()required every iteration underSHARE_COORDINATE_MANAGERmode, or the kernel-map cache grows unboundedtorchrun, NCCL,DistributedSampler(drop_last=True),find_unused_parameters=True; pickling fix from PR Fix pickling error for MinkowskiConvolutionFunction during ddp training NVIDIA/MinkowskiEngine#139. Honest note: multi-GPU is upstream functionality this fork has not re-validated on torch 2.9; single-GPU is the tested pathtorch._dynamo.disable()on the sparse backbone, compile only the dense headME.set_deterministic()noted as planned but not yet mergedStyle matches
docs/performance.md: code-snippet-first, concise, no em dashes. Upstream issue numbers cited inline as plain links.Test plan
docs/operations.mdrenders correctly in the hosted Sphinx docsdocs/index.rsttoctree entry is correctly placedGenerated with Claude Code