Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add iOS On Device Training Tutorial with ONNX Runtime #17146

Merged
merged 45 commits into from
Aug 17, 2023
Merged

Add iOS On Device Training Tutorial with ONNX Runtime #17146

merged 45 commits into from
Aug 17, 2023

Conversation

vraspar
Copy link
Contributor

@vraspar vraspar commented Aug 14, 2023

Description

This pull request introduces comprehensive tutorial for performing on device training on iOS devices using Objective-C/Swift on device training APIs.

Preview: https://vraspar.github.io/onnxruntime/docs/tutorials/on-device-training/ios-app.html
Example App: https://github.com/microsoft/onnxruntime-training-examples/tree/master/on_device_training/mobile/ios/MyVoice

@vraspar
restructure on device training tutorial content
b7b56bd
@vraspar
fix broken links
5f3d2c7
@vraspar
Merge branch 'gh-pages' of https://github.com/vraspar/onnxruntime int…
6b4734d 
…o gh-pages
@vraspar
Add training artifacts and installtion guide
406f7b2
@vraspar
Merge branch 'microsoft:gh-pages' into gh-pages
8778c6b
@vraspar
fix formatting and links
5603b17
@vraspar
Merge branch 'gh-pages' of https://github.com/vraspar/onnxruntime int…
0111a73 
…o gh-pages
@vraspar
add recording generation steps
f1e542c
@vraspar
Merge branch 'gh-pages' of https://github.com/vraspar/onnxruntime int…
27dd7a7 
…o gh-pages
@vraspar
add training model instructions
adc7da2
@vraspar
Add inference instructions
07f4273
@vraspar
Add recording instructions
501b5f3
@vraspar
Add Instructions for UI
4fce766
@vraspar
fix spell errors
899e6ac
@vraspar
add images for running the app section
38d7411
@vraspar
Fix spelling errors
ee0bd85
edgchen1
edgchen1 reviewed Aug 15, 2023
View reviewed changes
Copy link
Contributor

@edgchen1 edgchen1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good! some minor comments, just being kind of picky as this is user facing documentation

docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
vraspar and others added 8 commits August 14, 2023 21:59
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
16fde62 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
31d7a72 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
fedc010 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
af7c65a 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
45eef1a 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
faa55df 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
55b2521 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
57d5471 
Co-authored-by: Edward Chen <[email protected]>
vraspar and others added 17 commits August 14, 2023 22:01
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
ff2e1e6 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
4857b45 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
5c9008f 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
aa4ecb9 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
4e07555 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
70fb55d 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
ebe213d 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
1da52e0 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
67f24b9 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
1ed87af 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
e0cdebc 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
2fc9663 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
ca07e01 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
03a2ce2 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
62f945a 
Co-authored-by: Edward Chen <[email protected]>
@vraspar @edgchen1
Update docs/tutorials/on-device-training/ios-app.md
0c38036 
Co-authored-by: Edward Chen <[email protected]>
@vraspar
Rename images and fix formatting
14e91ea
edgchen1
edgchen1 previously approved these changes Aug 16, 2023
View reviewed changes
baijumeswani
baijumeswani reviewed Aug 16, 2023
View reviewed changes
Copy link
Contributor

@baijumeswani baijumeswani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work with the tutorial. :) Looks good (except for a few minor comments).

docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Outdated Show resolved Hide resolved
docs/tutorials/on-device-training/ios-app.md Show resolved Hide resolved
@vraspar vraspar merged commit fcd241f into microsoft:gh-pages Aug 17, 2023
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@edgchen1 edgchen1 edgchen1 approved these changes

@baijumeswani baijumeswani baijumeswani approved these changes

@askhade askhade Awaiting requested review from askhade

@natke natke Awaiting requested review from natke

@cassiebreviu cassiebreviu Awaiting requested review from cassiebreviu

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@vraspar @baijumeswani @edgchen1