Commit graph

38 commits

Author SHA1 Message Date
Wanming Lin
944db3ed6c
[WebNN EP] Add WebNN doc (#20733)
- Add WebNN EP build instruction
- Update WebNN Chromium flag in tutorial
- Some minor updates
2024-05-21 00:17:31 -07:00
Sophie Schoenmeyer
82e2da0819
Update with-python.md with CUDA 12.X instructions (#20442)
### Description
with-python.md does not currently include installation instructions for
CUDA 12.X, so I added the instructions from
https://onnxruntime.ai/docs/execution-providers/CUDA-ExecutionProvider.html#requirements.



### Motivation and Context
<!-- - Why is this change required? What problem does it solve?
- If it fixes an open issue, please link to the issue here. -->
2024-04-23 14:32:17 -07:00
Yulong Wang
cfdb434a08
[doc] Update "Get Started" page for ORT web (#19568)
### Description
This PR re-arranges documentation of ORT web.

Current doc: https://onnxruntime.ai/docs/
Change preview: https://fs-eire.github.io/onnxruntime/docs/

- split `Doc -> Get Started -> JavaScript` from single page into
multiple pages, to make it easier to split from web, node and
react-native
- remove `Doc -> Get Started -> with Web`. The page was a few links and
now they are moved to other places
- add a few contents into `Doc -> Get Started -> JavaScript -> Web`. Now
this is the main page for ORT web doc.
- rename `Tutorials -> deploy on Web` to `Tutorials -> Web`. "deploy" is
confusing as it's not the accurate term to describe the content.

=================================================================


### Discussions:
TBD


=================================================================


### ORT web documentation work item list:

- [ ] Update `Get Started` page for ORT web at onnxruntime.ai **( this
PR )**
    - to make it easier for users to navigate
- [ ] Update `Tutorials` page for ORT web at onnxruntime.ai
- The purpose of this page is unclear. It contains descriptive
information and step-by-step instructions on an E2E examples. It can be
a good Blog, but not good for documentation, which usually has a
well-structured content.
- The [index
page](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/) has
duplicated contents with its child page ["Build a web application with
ONNX
Runtime"](https://fs-eire.github.io/onnxruntime/docs/tutorials/web/build-web-app.html)
    - Some contents are out-of-dated.
- [ ] Update [`API Usage -
SessionOptions`](https://github.com/microsoft/onnxruntime-inference-examples/tree/main/js/api-usage_session-options)
on onnxruntime-inference-examples repo.
- Add explaination and examples if necessary for all new WebGPU session
options.
- [ ] Update [`API usage - ort.env
flags`](https://github.com/microsoft/onnxruntime-inference-examples/blob/main/js/api-usage_ort-env-flags)
on onnxruntime-inference-examples repo.
    - Add all newly introduced flags.
2024-02-22 16:41:35 -08:00
Caroline Zhu
ad7d0fbc74
Add web documentation + installation instructions (#19342)
### Description
Updated docs section with information on installation and building. 

Live previews of modified pages:
* [Installation
table](https://carzh.github.io/onnxruntime/getting-started) -- under the
Optimize Training tab
* [Build for
training](https://carzh.github.io/onnxruntime/docs/build/training.html)
* [Getting started with
web](https://carzh.github.io/onnxruntime/docs/get-started/with-web.html)
-- added link to E2E demo code
* [Install for on-device
training](https://carzh.github.io/onnxruntime/docs/install/#install-for-on-device-training)
* [Tutorials page for On-device
training](https://carzh.github.io/onnxruntime/docs/tutorials/on-device-training/)
-- this page looks a little odd with just the link to the E2E demo.
potential alternative of creating a separate page that links to the demo
+ mentions that a tutorial will be coming soon?


### Motivation and Context
- Updating docs with information about ORT Training for Web for 1.17
release
2024-01-31 15:29:52 -08:00
Tianlei Wu
7720b66295
Fix nightly python package links in document (#18770)
### Description
Fix nightly python package links.

### Motivation and Context
https://github.com/microsoft/onnxruntime/issues/15608
https://github.com/microsoft/onnxruntime/pull/18712
2023-12-20 23:27:00 -08:00
Dmitri Smirnov
f3fa223ee8
Update C# Pages in view of the new preferred inference API (#17642)
### Description
Re-work C# code samples with OrtValue API.
Bring `C# Tutorial: Basic` to index. 

The site is currently published
[here](https://yuslepukhin.github.io/onnxruntime)


### Motivation and Context
Direct all future usage to `Ortvalue` API
2023-09-26 10:35:20 -07:00
Yulong Wang
e62689f7ce
[doc] update document for webgpu (#16245)
### Description

update document for webgpu

Preview: https://fs-eire.github.io/onnxruntime/docs/
2023-06-06 13:00:33 -07:00
Baiju Meswani
25125b5b91
Training related changes to the onnxruntime website (#15900)
Changes include:

- Added a new page for `On-Device Training` overview:
[Preview](https://baijumeswani.github.io/onnxruntime/docs/get-started/on-device-training.html)
- Added a new section for `On-Device Training` installation:
[Preview](https://baijumeswani.github.io/onnxruntime/docs/install/#install-for-on-device-training)
- Added a new section for `On-Device Training` build from source:
[Preview](https://baijumeswani.github.io/onnxruntime/docs/build/training.html#build-for-on-device-training)
- Updated Large Model Training overview, installation, build pages to
reflect what is currently accurate.

Website preview: https://baijumeswani.github.io/onnxruntime/


Pending website work:
- Update links for released packages for training.
- Add tutorial for on-device training
- Add links to the blog posts that detail on device training.
2023-05-17 14:45:52 -07:00
Rachel Guo
e2dda61278
[doc] Add instructions for configuration of react native with extensions (#15881) 2023-05-16 12:52:40 -07:00
Faith Xu
3681048474
[Docs] Update performance sections (#15071)
### Description
Staged: https://faxu.github.io/onnxruntime/docs/performance/

Main changes:
- Restructure performance section to break into sub-categories
- Move CUDA specific perf tuning tips to [CUDA EP
page](https://faxu.github.io/onnxruntime/docs/execution-providers/CUDA-ExecutionProvider.html#performance-tuning)
- Update [Transformer optimizer
page](https://faxu.github.io/onnxruntime/docs/performance/transformers-optimization.html)
to remove version-specific content... will be supported along with
https://github.com/microsoft/onnxruntime/pull/14964
- Fix links to point to new pages
2023-03-17 15:39:22 -07:00
Prasanth Pulavarthi
f69691fb1d Revert "Revert "Merge branch 'gh-pages' of https://github.com/microsoft/onnxruntime into gh-pages""
This reverts commit 20c745c749.
2023-03-10 17:02:38 -08:00
Prasanth Pulavarthi
20c745c749 Revert "Merge branch 'gh-pages' of https://github.com/microsoft/onnxruntime into gh-pages"
This reverts commit 063f84744e, reversing
changes made to 6f2f1e8dac.
2023-03-10 16:58:21 -08:00
Nat Kershaw (MSFT)
e3e4ab0162
Add link to candy style transfer sample (#14969) 2023-03-08 15:52:19 -08:00
Faith Xu
bd9b15fd4d
[Docs] Docs updates (#14824)
### Description
Staged: https://faxu.github.io/onnxruntime/docs/

Changes:
- ~~New dedicated section on sidebar for
[Mobile](https://faxu.github.io/onnxruntime/docs/mobile/) and
[Web](https://faxu.github.io/onnxruntime/docs/web/)~~ New dedicated
pages for
[Mobile](https://faxu.github.io/onnxruntime/docs/get-started/with-mobile.html)
and
[Web](https://faxu.github.io/onnxruntime/docs/get-started/with-web.html)
under Getting Started section
- [Transformers
optimizer](https://faxu.github.io/onnxruntime/docs/performance/transformers-optimization.html)
documentation
- Move contrib op section from "Custom Operators" page to ["Contrib
operators"
page](https://faxu.github.io/onnxruntime/docs/reference/operators/ContribOperators.html)
- Update [releases
page](https://faxu.github.io/onnxruntime/docs/reference/releases-servicing.html)
2023-03-08 11:54:58 -08:00
Maanav Dalal
9913bf5a8a
Website Visual Updates & Fixing Broken Links (#14430) 2023-01-27 13:10:22 -08:00
Edward Chen
e17d43dbdd
[doc] Update mobile custom build instructions, update ORT GitHub URLs to use 'main' (#14409) 2023-01-24 10:46:24 -08:00
Nat Kershaw (MSFT)
048dbb5409
Update with-python.md (#13945) 2022-12-13 11:07:53 -08:00
Cassie Breviu
f5b30bdfc9
update links to new api (#12836) 2022-09-02 08:32:39 -07:00
brev
980211b477
Create C# inference section and added C# BERT NLP tutorial (#12472) 2022-08-04 15:59:28 -07:00
Nat Kershaw (MSFT)
8c23c57a9f
Refactor DirectML and Windows docs (#12096) 2022-07-06 09:52:42 -07:00
Nat Kershaw (MSFT)
7f7f47183b
Fix Objective C link (#11755) 2022-06-07 10:42:20 -07:00
XinYuan
960f2a1a90
Fixed markdown syntax error and modify field name to keep the style consistent (#8659) 2022-06-05 20:34:31 -07:00
pkreg101
7144892eaa
Minor improvements to JavaScript Get started (#11285) 2022-04-22 11:48:34 -07:00
Nat Kershaw (MSFT)
19e1933e92
Clarify Python package install instructions (#10718) 2022-03-01 20:30:23 -08:00
Nat Kershaw (MSFT)
38b55f2345
Update with-python.md (#10647) 2022-02-23 13:16:05 -08:00
Nat Kershaw (MSFT)
a04ed78989
Move community APIs a level up in visibility (#9952) 2021-12-13 12:21:25 -08:00
Gary Miguel
41a714bbb3
Lots of minor doc improvements (#9930) 2021-12-10 17:43:15 -08:00
Nat Kershaw (MSFT)
d03f868944
Refactor web and mobile docs (#9854) 2021-12-10 16:22:10 -08:00
Prasanth Pulavarthi
a5c0ba8cf3
Add links to community maintained Julia bindings (#9773)
* Add links to community maintained Julia bindings

* Add community API links to Getting Started page
2021-11-17 16:35:49 -08:00
Nat Kershaw (MSFT)
14825b3461
Add automatic link checking to docs website (and fix broken links) (#9566) 2021-10-27 10:43:10 -07:00
Faith Xu
6c8c8a9b12
[Docs] Update CUDA/TRT versions and menu format fixes (#9317)
* update cuda/trt versions

* update API doc links

* remove api doc parentage

* fix menu

* fix broken links

* open api links in new window
2021-10-14 11:28:17 -07:00
Yulong Wang
74e44220e3
[doc] update documents for JavaScript API (#9173)
* install

* update comments in install cmd

* update get-started-with-javascript

* add .no_toc

* correct .no_toc
2021-10-11 13:59:04 -07:00
Faith Xu
c878b7e988
[Docs] Fix links and formatting (#9253)
* fix links and format issues

* fix sidebar ordering
2021-10-05 11:50:38 -07:00
Cassie
a0f3e30de6
Docs update: updated nav, get started sections, home page, apis (#9060)
* initial setup and rename "how to" to "setup"

* move API to main nav

* move api to main nav

* add get starated, rework nav order

* rename to install move mds out of install section

* update api nav and home page

* add install docs and python qs updates

* python get started work

* remove c and obj c for now

* move java, python, and obj-c docs under api folder

* move java api html to iframe (ugh)

* remove api docs w/o details, move api text getstar

* remove api docs wo detail updates get started

* remvoe iframes

* move eco system to main nav

* fix api buttons

* added more examples moved intro to ORT

* fix links

* fix get started titles

* fix get started titles

* fix more links

* fix more links

* more link fixes

* fix nav remove inferencing and training subnav

* fix top nav remove inference and training nav

* fix title

* fix tutorials nav hierarchy

* fix python api button

* add tenorflow keras example

* fix quickstart toc

* add imports fix spacing

* fix links

* update nav and python get started page

* move ort training example, add coming soon for iot

* update C# get started

* fix spacing on quantization

* Add some js get started content

* fix formatting

* fix typo

* removed onnx-pytorch and onnx-tf

* updated pip install torch and added links iot page

* added pytorch tutorial heirarchy

* updated web to docs soon added release blog link

* add web link
2021-09-15 16:23:42 -05:00
Faith Xu
0f6f0d9bbb
Major updates/restructure for documentation (#7609)
* Update documentation.

Updates documentation.

* Update tf-get-started.md
2021-05-10 15:19:37 -07:00
Faith Xu
e2d75e54b0
Website and docs updates for 1.7 (#6718)
* update version #s

* Update CUDA versions

* Fix table

* Fix typo

* table update

* update link

* Add search bar

* Update for Windows ARM packages

* Add quantization.md

* Remove page

* Re-add quantization page
2021-03-01 10:53:13 -08:00
Nat Kershaw (MSFT)
2dd2363cc1
Docs sweep of recent changes into gh-pages from master (#5773) 2020-12-01 16:10:58 -08:00
Nat Kershaw (MSFT)
15291ab4c9
Migrate content from GitHub source to GitHub pages (#5053)
* Test re-using page layout from current ONNX Runtime website for docs

* Add content for documentation on website

* Fixed most broken links

* Copy just-the-docs theme sources into repo

* Remove local theme files as this did not work with GitHub

* Remove nojekyll file

* Move image assets into single location

* Add Contents to markdown files and ensure only one h1

* Update after review

* Fix img links

* Add trailing slash to main nav links

* Fix broken links on main docs page

* Re-fix broken links on main docs page

* Fix broken links #3

* Fix broken links #4

* Fix broken links #5

* Fix broken links #6

* Fix paths to global assets

* Add updates since fork

* Update custom op docs

* Fix link
2020-10-12 10:28:20 -07:00