-
Notifications
You must be signed in to change notification settings - Fork 12.2k
(docs): Improve README file for Navi #550
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
# Navi: High-Performance Machine Learning Serving Server in Rust | ||
|
||
Navi is a high-performance, versatile machine learning serving server implemented in Rust, tailored for production usage. It's designed to efficiently serve within the Twitter tech stack, offering top-notch performance while focusing on core features. | ||
Navi is a high-performance, versatile machine learning serving server implemented in Rust and tailored for production usage. It's designed to efficiently serve within the Twitter tech stack, offering top-notch performance while focusing on core features. | ||
|
||
## Key Features | ||
|
||
|
@@ -23,12 +23,14 @@ While Navi's features may not be as comprehensive as its open-source counterpart | |
- `thrift_bpr_adapter`: generated thrift code for BatchPredictionRequest | ||
|
||
## Content | ||
We include all *.rs source code that makes up the main navi binaries for you to examine. The test and benchmark code, as well as configuration files are not included due to data security concerns. | ||
We have included all *.rs source code files that make up the main Navi binaries for you to examine. However, we have not included the test and benchmark code, as well as various configuration files, due to data security concerns. | ||
|
||
## Run | ||
in navi/navi you can run. Note you need to create a models directory and create some versions, preferably using epoch time, e.g., 1679693908377 | ||
- scripts/run_tf2.sh | ||
- scripts/run_onnx.sh | ||
In navi/navi, you can run the following commands: | ||
- `scripts/run_tf2.sh` for [TensorFlow](https://www.tensorflow.org/) | ||
- `scripts/run_onnx.sh` for [Onnx](https://onnx.ai/) | ||
|
||
Do note that you need to create a models directory and create some versions, preferably using epoch time, e.g., `1679693908377`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Note should be placed before shell files. |
||
|
||
## Build | ||
you can adapt the above scripts to build using Cargo | ||
You can adapt the above scripts to build using Cargo. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"as well as" implies conjunction with a positive statement. The correct verbiage here would probably be "or":
I would also recommend dropping the "the":
The comma between "code" and "or", and "files" and "due", has a panache that draws attention from the next clause. An em dash might be necessary here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agree. will fix in original code and propogate to the open source version.