Personalizing a Model with On-Device Updates
At a glance
| Item | Summary |
|---|---|
| Purpose | Modify an updatable Core ML model by running an update task with labeled data. |
| App architecture | A Swift sample with the source-visible chain AppDelegate → CreateNewStickerViewController → CoreML APIs. |
| Main patterns | View-controller organization, Protocol-oriented abstraction, Delegate or data-source callbacks |
| Project style | 13 scanned source file(s) across Swift, organized around ranked entry, type, and file boundaries. |
Project structure
Source bundle/
└── PersonalStickers/
├── App/
│ └── AppDelegate.swift
├── ViewControllers/
│ ├── DrawingCanvasViewController.swift
│ ├── CreateNewStickerViewController.swift
│ ├── ExampleDrawingViewController.swift
│ ├── MainCanvasViewController.swift
│ ├── ProvideExampleDrawingsViewController.swift
│ └── EmojiCell.swift
├── Drawing Data/
│ ├── ExampleDrawingSet.swift
│ └── UserDrawing.swift
└── Model/
├── ModelUpdater.swift
├── UpdatableDrawingClassifier+ImageConstraint.swift
└── UpdatableDrawingClassifier+Prediction.swift
Structure observations
- Architecturally prominent files are ranked from entry points and role-named declarations; resource-only paths are omitted.
- Primary languages: Swift.
- The verified tree contains 6 project/configuration file(s) and 11 source declaration(s).
Overall architecture
flowchart LR
N1["AppDelegate"]
N2["CreateNewStickerViewController"]
N3["CoreML APIs"]
N1 --> N2
N2 --> N3
Reference code
PersonalStickers/App/AppDelegate.swift:10 — architecture anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
}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 Core ML.
Ownership and state
classDiagram
AppDelegate o-- UIWindow : window
DrawingCanvasViewController o-- DrawingDelegate : delegate
DrawingCanvasViewController o-- DispatchWorkItem : submitWorkItem
DrawingCanvasViewController o-- PKCanvasView : canvasView
Ownership evidence
PersonalStickers/App/AppDelegate.swift:12 — stored dependency or nearest verified ownership anchor
@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
var window: UIWindow?
}| Owner | Object or state | Relationship | Mutation authority |
|---|---|---|---|
AppDelegate |
UIWindow (window) |
stores or receives | App/module collaborators |
DrawingCanvasViewController |
DrawingDelegate (delegate) |
holds a non-owning reference | The referenced object’s lifecycle is owned elsewhere |
DrawingCanvasViewController |
DispatchWorkItem (submitWorkItem) |
stores or receives | App/module collaborators |
DrawingCanvasViewController |
PKCanvasView (canvasView) |
holds a non-owning reference | The referenced object’s lifecycle is owned elsewhere |
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.
Class and protocol design
PersonalStickers/ViewControllers/DrawingCanvasViewController.swift:12 — representative type boundary
protocol DrawingDelegate: AnyObject {
func didProduce(drawing: UserDrawing, sender: Any?)
}| Type | Responsibility | Depends on or conforms to |
|---|---|---|
AppDelegate |
Receives callback-driven events | UIResponder, UIApplicationDelegate |
DrawingDelegate |
Defines a capability or collaboration contract | AnyObject |
DrawingCanvasViewController |
View lifecycle, callbacks, and feature coordination | UIViewController, PKCanvasViewDelegate |
CreateNewStickerViewController |
View lifecycle, callbacks, and feature coordination | UICollectionViewController |
ExampleDrawingViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
MainCanvasViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
ProvideExampleDrawingsViewController |
View lifecycle, callbacks, and feature coordination | UIViewController |
ExampleDrawingSet |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
UserDrawing |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
ModelUpdater |
Represents a feature value or composable behavior | Concrete collaborators/imported frameworks |
The source explicitly defines local protocol relationships: ExampleDrawingViewController → DrawingDelegate, MainCanvasViewController → DrawingDelegate, ProvideExampleDrawingsViewController → DrawingDelegate.
Access control
| Symbol | Access | Verified effect | Likely rationale |
|---|---|---|---|
requiredDrawingCount (PersonalStickers/Drawing Data/ExampleDrawingSet.swift:15) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
trainingDrawings (PersonalStickers/Drawing Data/ExampleDrawingSet.swift:18) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
ciContext (PersonalStickers/Drawing Data/UserDrawing.swift:15) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
whiteTintedImage (PersonalStickers/Drawing Data/UserDrawing.swift:37) |
private |
Use is restricted to the lexical declaration and same-file extensions allowed by Swift. | Inference: keep state mutation or dependency lifetime inside the owning implementation. |
Reference code
PersonalStickers/Drawing Data/ExampleDrawingSet.swift:15 — representative boundary
struct ExampleDrawingSet {
// ...
private let requiredDrawingCount = 3
// ...
}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
| Logic | Owning type or file | Placement rationale |
|---|---|---|
| View lifecycle, callbacks, and feature coordination | CreateNewStickerViewController, DrawingCanvasViewController, ExampleDrawingViewController, MainCanvasViewController |
The source’s Controller suffix makes this role explicit. |
| Receives callback-driven events | AppDelegate, DrawingDelegate |
The source’s Delegate suffix makes this role explicit. |
Design patterns
| Pattern | Source evidence | Purpose or tradeoff |
|---|---|---|
| View-controller organization | PersonalStickers/ViewControllers/CreateNewStickerViewController.swift:10 |
A controller is the verified coordination boundary; this is MVC-style only where a separate model is present. |
| Protocol-oriented abstraction | PersonalStickers/ViewControllers/ExampleDrawingViewController.swift:32 |
A local protocol and concrete conformance create an explicit capability boundary. |
| Delegate or data-source callbacks | PersonalStickers/App/AppDelegate.swift:11 |
Callback protocols invert event delivery back into the sample’s owner. |
Naming conventions
- Types: Controller: CreateNewStickerViewController, DrawingCanvasViewController, ExampleDrawingViewController, MainCanvasViewController, ProvideExampleDrawingsViewController; Delegate: AppDelegate, DrawingDelegate.
- Protocols:
DrawingDelegate. - Methods:
didProduce,viewDidLoad,configureCanvasView,canvasViewDidBeginUsingTool,canvasViewDrawingDidChange,submitDrawing,makeTrainingViewController,cancel. - Files:
PersonalStickers/App/AppDelegate.swift,PersonalStickers/ViewControllers/DrawingCanvasViewController.swift,PersonalStickers/ViewControllers/CreateNewStickerViewController.swift,PersonalStickers/ViewControllers/ExampleDrawingViewController.swift,PersonalStickers/ViewControllers/MainCanvasViewController.swift,PersonalStickers/ViewControllers/ProvideExampleDrawingsViewController.swift.
Architecture takeaways
AppDelegateis the main source-visible entry or composition anchor for this sample.- Framework work reaches UIKit, CoreML, CoreImage, PencilKit 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.
- Local protocol relationships provide an explicit substitution boundary.
Source map
| Source file | Relevant symbols |
|---|---|
PersonalStickers/App/AppDelegate.swift |
AppDelegate |
PersonalStickers/ViewControllers/DrawingCanvasViewController.swift |
DrawingDelegate, DrawingCanvasViewController |
PersonalStickers/ViewControllers/CreateNewStickerViewController.swift |
CreateNewStickerViewController |
PersonalStickers/ViewControllers/ExampleDrawingViewController.swift |
ExampleDrawingViewController |
PersonalStickers/ViewControllers/MainCanvasViewController.swift |
MainCanvasViewController |
PersonalStickers/ViewControllers/ProvideExampleDrawingsViewController.swift |
ProvideExampleDrawingsViewController |
PersonalStickers/Drawing Data/ExampleDrawingSet.swift |
ExampleDrawingSet |
PersonalStickers/Drawing Data/UserDrawing.swift |
UserDrawing |
PersonalStickers/Model/ModelUpdater.swift |
ModelUpdater |
PersonalStickers/ViewControllers/EmojiCell.swift |
EmojiCell |