Customizing a PyTorch operation

At a glance

Project structure

Source bundle/
├── softshrink.py
├── CustomSoftshrink.h
├── CustomSoftshrink.mm
├── compiler.py
└── run_sample.py

Structure observations

• Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
• Primary languages: C/Objective-C header, Objective-C++, Python.
• The verified tree contains 0 project/configuration file(s) and 3 source declaration(s).

Overall architecture

flowchart LR
    N1["run_sample"]
    N2["CustomMPSSoftshrinkModel"]
    N3["Metal / metal_stdlib APIs"]
    N1 --> N2
    N2 --> N3

Reference code

run_sample.py:58 — architecture anchor

if __name__ == "__main__":

Interpretation

The arrows summarize the source-visible entry, role-named types or folders, and framework direction; when nodes come from structural folders, the sequence is a high-level interpretation rather than proof that every adjacent node calls the next. Ownership is claimed only where the next section cites a stored property or assignment. The diagram is intentionally limited to the dominant path into Metal.

Ownership and state

classDiagram
    run_sample --> MetalAPIs : uses

Ownership evidence

softshrink.py:10 — stored dependency or nearest verified ownership anchor

import torch

Composition arrows indicate a source-visible construction expression or locally owned value state; aggregation means the owner stores or receives a dependency without proving exclusive lifetime ownership.

Concurrency, scheduling, and thread safety

Evidence limit: actor isolation, async/await, or Task creation does not by itself prove background-thread execution; Sendable conformance alone does not prove thread-safe mutation.

No source-visible execution, scheduling, or synchronization boundary was found in the indexed source.

@MainActor/MainActor.run, DispatchQueue.main, and RunLoop.main are reported as distinct isolation, queue, and event-loop mechanisms. A plain Task is kept separate from Task.detached; neither is labeled as a background thread.

State propagation, frameworks, and dependencies

Evidence limit: an import proves a source-level compilation dependency at the cited line; it does not prove runtime use, architectural adoption, or whether a Swift package is a direct application dependency.

receive(on:) describes downstream delivery scheduling, while subscribe(on:) describes upstream subscription/request/cancel scheduling. An import Combine alone establishes neither behavior nor a Store, reducer, Redux, or other application architecture.

Class and protocol design

softshrink.py:33 — representative type boundary

class CustomMPSSoftshrinkModel(nn.Module):
    # ...

No local protocol conformance is claimed as protocol-oriented design; external framework conformances are listed only as dependencies.

Access control

Reference code

CustomSoftshrink.h:11 — representative boundary

static char *CUSTOM_KERNEL = R"MPS_SOFTSHRINK(
// ...
)MPS_SOFTSHRINK";

Swift declarations without a modifier are internal; explicit private, fileprivate, private(set), public, or open entries above are interpreted by language semantics. Objective-C/C samples instead rely on header and implementation boundaries, which are not equivalent to Swift lexical privacy.

Logic ownership and placement

Design patterns

Naming conventions

• Types: Model: CustomMPSSoftshrinkModel, SoftshrinkModel.
• Protocols: no local protocol declaration in the scanned source.
• Methods: __init__, forward, extra_repr, state, test_speedup, test_correctness, test_softshrink.
• Files: feature/project roles rather than a strict one-type-per-file rule.

Architecture takeaways

• run_sample is the main source-visible entry or composition anchor for this sample.
• Framework work reaches Metal, metal_stdlib, torch through a deliberately small high-level chain; the detailed API graph remains inside the cited implementation files.
• Stored-property evidence identifies lifecycle collaboration; it does not by itself prove exclusive object ownership.
• Access-control conclusions separate verified language visibility from the likely design rationale.
• The source does not justify labeling the design protocol-oriented.

Source map

• Official Apple documentation