ray/doc/source/serve/user-guide.md

(serve-user-guides)=
# User Guides

If you’re new to Ray Serve, we recommend starting with the [Ray Serve Quick Start](getting_started).

This user guide will help you navigate the Ray Serve project and show you how achieve several tasks, for instance
you will learn
- [Create/Update/Delete Serve Deployments](managing-deployments)
- [Handling Dependencies](handling-dependencies)
- [Configuring HTTP and Bring Your own FastAPI app](http-guide)
- [Using HTTP Adapters](http-guide)
- [Composing Deployments](handle-guide)
- [Serving ML Models](ml-models)
- [Use Request Batching](batching-guide)
- [Using Deployment Graphs](serve-model-composition-deployment-graph)
- [Deploying Ray Serve](deploying-serve)
- [Monitoring Ray Serve](monitoring)
- [Performance Tuning](performance)
- [Autoscaling](autoscaling)
-												[Docs] [Serve] Has a consistent landing page style (#26029)


											
										
										
											2022-07-09 02:58:21 +08:00
+								(serve-user-guides)=
-												[Serve][Doc] Split core-apis to key concepts and user guide (#24713)


											
										
										
											2022-05-20 10:56:34 -07:00
+								# User Guides
 								If you’re new to Ray Serve, we recommend starting with the [Ray Serve Quick Start](getting_started).
 								This user guide will help you navigate the Ray Serve project and show you how achieve several tasks, for instance
 								you will learn
 								- [Create/Update/Delete Serve Deployments](managing-deployments)
 								- [Handling Dependencies](handling-dependencies)
 								- [Configuring HTTP and Bring Your own FastAPI app](http-guide)
-												[Serve/Doc] Update http with serve user guide (#27536)

- Merge http user guides and http adapter
- Update the code to use bind()
- Remove some unsupported content
- minor wording improvement
											
										
										
											2022-08-09 09:42:34 -07:00
+								- [Using HTTP Adapters](http-guide)
-												[Serve][Doc] Split core-apis to key concepts and user guide (#24713)


											
										
										
											2022-05-20 10:56:34 -07:00
+								- [Composing Deployments](handle-guide)
 								- [Serving ML Models](ml-models)
-												[Serve][Doc] Add Batching User Guide (#27731)

Add a new page discussing how to use the batching decorator.
											
										
										
											2022-08-11 12:06:27 -07:00
+								- [Use Request Batching](batching-guide)
-												[Serve] [Docs] Add consolidated `Model Composition` user guide (#26860)

This change adds introductory deployment graph documentation.

Links to updated documentation:
* [Model Composition](https://ray--26860.org.readthedocs.build/en/26860/serve/model_composition.html)
* [Examples Overview](https://ray--26860.org.readthedocs.build/en/26860/serve/tutorials/index.html)
* [Deployment Graph Pattern Overview](https://ray--26860.org.readthedocs.build/en/26860/serve/tutorials/deployment-graph-patterns.html)
  * [Pattern: Linear Pipeline](https://ray--26860.org.readthedocs.build/en/26860/serve/tutorials/deployment-graph-patterns/linear_pipeline.html)
  * [Pattern: Branching Input](https://ray--26860.org.readthedocs.build/en/26860/serve/tutorials/deployment-graph-patterns/branching_input.html)
  * [Pattern: Conditional](https://ray--26860.org.readthedocs.build/en/26860/serve/tutorials/deployment-graph-patterns/conditional.html)

Co-authored-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
											
										
										
											2022-08-09 15:06:23 -07:00
+								- [Using Deployment Graphs](serve-model-composition-deployment-graph)
-												[Serve][Doc] Split core-apis to key concepts and user guide (#24713)


											
										
										
											2022-05-20 10:56:34 -07:00
+								- [Deploying Ray Serve](deploying-serve)
-												[Doc] [Serve] Refresh code for "monitoring" for 2.0 (#27400)


											
										
										
											2022-08-04 20:10:12 -07:00
+								- [Monitoring Ray Serve](monitoring)
-												[Serve] Fix misspell in Serve Doc User Guides. (#25494)


											
										
										
											2022-06-07 05:00:20 +09:00
+								- [Performance Tuning](performance)
-												[Serve][Doc] Autoscaling (#25646)

- new section of doc for autoscaling (introduction of serve autoscaling and config parameter)
- Remove the version requirement note inside the doc

Co-authored-by: Simon Mo <simon.mo@hey.com>
Co-authored-by: Edward Oakes <ed.nmi.oakes@gmail.com>
Co-authored-by: shrekris-anyscale <92341594+shrekris-anyscale@users.noreply.github.com>
Co-authored-by: Archit Kulkarni <architkulkarni@users.noreply.github.com>
											
										
										
											2022-06-22 13:32:18 -07:00
+								- [Autoscaling](autoscaling)