Skip to content

Documentation Refresh#1990

Merged
faxu merged 43 commits intomasterfrom
faxu-docs-updates
Oct 15, 2019
Merged

Documentation Refresh#1990
faxu merged 43 commits intomasterfrom
faxu-docs-updates

Conversation

@faxu
Copy link
Copy Markdown
Contributor

@faxu faxu commented Oct 3, 2019

Update and clean up lots of the documentation.

@faxu
Copy link
Copy Markdown
Contributor Author

faxu commented Oct 8, 2019

If you have a Linux machine, preface this command with "sudo"

docker run should not require sudo. Please remove this line.

Refers to: dockerfiles/README.md:271 in c2b07f6. [](commit_id = c2b07f6, deletion_comment = False)

Should this also be applied to all other instructions for all docker run instructions on that page?

@faxu faxu changed the title [WIP] Documentation Refresh Documentation Refresh Oct 8, 2019
@jywu-msft
Copy link
Copy Markdown
Member

If you have a Linux machine, preface this command with "sudo"

docker run should not require sudo. Please remove this line.
Refers to: dockerfiles/README.md:271 in c2b07f6. [](commit_id = c2b07f6, deletion_comment = False)

Should this also be applied to all other instructions for all docker run instructions on that page?

yes, applies to all EPs. docker build and docker run does not require sudo.
one should run as normal user (adding the user to docker group)


## Cross Platform
[API documentation and package installation](#installation)
ONNX Runtime is currently available for Linux, Windows, and Mac with Python, C#, C++, and C APIs. Please see [API documentation and package installation](#installation).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

May consider adding Android here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

we can add it once we've confirmed NN API readiness.

@@ -70,30 +70,32 @@ sess_options.intra_op_num_threads=2
sess_options.enable_sequential_execution=True
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

sess_options.enable_sequential_execution=True

Pranav is changing the API. When his has done the work, we should review this part and refresh it again.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

CC @pranavsharma please note and include this update as part of your PR

snnn
snnn previously approved these changes Oct 10, 2019
snnn
snnn previously approved these changes Oct 15, 2019
@faxu faxu merged commit ec136ac into master Oct 15, 2019
@faxu faxu deleted the faxu-docs-updates branch October 21, 2019 18:55
yuslepukhin pushed a commit that referenced this pull request Mar 17, 2026
## Describe your changes

Refactor docker system:
1. If user specific docker system as host, the whole workflow will run
in the docker contianer.
2. Remove pass run and evaluation run support for docker system.
3. No need to add workflow_host for docker system.
4. Remove managed docker system support. User needs to provide his own
Dockerfile.
5. Remove unused docker integration test.
6. Update unit tests and docs.

## Checklist before requesting a review
- [ ] Add unit tests for this change.
- [ ] Make sure all tests can pass.
- [ ] Update documents if necessary.
- [ ] Lint and apply fixes to your code by running `lintrunner -a`
- [ ] Is this a user-facing change? If yes, give a description of this
change to be included in the release notes.
- [ ] Is this PR including examples changes? If yes, please remember to
update [example
documentation](https://github.com/microsoft/Olive/blob/main/docs/source/examples.md)
in a follow-up PR.

## (Optional) Issue link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants