[Serve] [Docs] Align file names in getting_started.md #36800
Merged
Conversation
This file contains 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
While running throught the tutorial (https://docs.ray.io/en/latest/serve/getting_started.html#getting-started), I was confused by the mismatch of the file names mentioned in the markdown explanations and the file names stated in the first line of the imported source files. This tries to fix the mismatch by changing the markdown. Alternatively, the imported source files could be changed. Signed-off-by: Alexander Junge <alexander.junge@gmail.com>
JungeAlexander
requested review from
edoakes,
shrekris-anyscale,
sihanwang41,
zcin,
architkulkarni and
a team
as code owners
edoakes
reviewed
Jun 26, 2023
This reverts commit a203421. Signed-off-by: Alexander Junge <alexander.junge@gmail.com>
Adjust file names to match serve_quickstart and serve_quickstart_composed Signed-off-by: Alexander Junge <alexander.junge@gmail.com>
@edoakes thanks for the feedback and no problem at all - I did just that. |
edoakes
approved these changes
Jun 27, 2023
8 tasks
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
) While running through the [getting started tutorial](https://docs.ray.io/en/latest/serve/getting_started.html#getting-started) for Ray Serve, I was confused by the mismatch of the file names mentioned in the markdown explanations and the file names stated in the first line of the imported source files. This fixes the mismatch by matching file names listed at the top of `doc/source/serve/doc_code/getting_started/model_deployment_full.py` and `doc/source/serve/doc_code/getting_started/model_graph.py` to the file names mentioned in the tutorial (`serve_quickstart.py` and `serve_quickstart_composed.py`, respectively). Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Why are these changes needed?
While running through the getting started tutorial for Ray Serve, I was confused by the mismatch of the file names mentioned in the markdown explanations and the file names stated in the first line of the imported source files.
This fixes the mismatch by matching file names listed at the top of
doc/source/serve/doc_code/getting_started/model_deployment_full.pyanddoc/source/serve/doc_code/getting_started/model_graph.pyto the file names mentioned in the tutorial (serve_quickstart.pyandserve_quickstart_composed.py, respectively).Related issue number
None.
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.