[AIR/Docs] Small improvements to Train user guide (#26577)

Co-authored-by: matthewdeng <[email protected]>
ray-project · Jul 16, 2022 · fb6f3cf · fb6f3cf
1 parent 6217138
commit fb6f3cf
Show file tree

Hide file tree

Showing 5 changed files with 323 additions and 264 deletions.
diff --git a/doc/source/ray-air/checkpoints.rst b/doc/source/ray-air/checkpoints.rst
@@ -1,3 1,5 @@
 .. _air-checkpoints:
 
 Checkpoints
 ===========
 

diff --git a/doc/source/ray-air/key-concepts.rst b/doc/source/ray-air/key-concepts.rst
@@ -39,13 39,14 @@ See the documentation on :ref:`Trainers <air-trainer-ref>`.
 
 
 
-Trainer objects will produce a :ref:`Results <air-results-ref>` object after calling ``.fit()``. These objects will contain training metrics as long as checkpoints to retrieve the best model.
 Trainer objects will produce a :ref:`Result <air-results-ref>` object after calling ``.fit()``. These objects will contain training metrics as long as checkpoints to retrieve the best model.
 
 .. literalinclude:: doc_code/air_key_concepts.py
  :language: python
  :start-after: __air_trainer_output_start__
  :end-before: __air_trainer_output_end__
 
 .. _air-session-key-concepts:
 
 Session
 -------

diff --git a/doc/source/ray-air/package-ref.rst b/doc/source/ray-air/package-ref.rst
@@ -45,6 45,8 @@ Abstract Classes
  :members:
  :show-inheritance:
 
 .. _air-results-ref:
 
 Training Result
 ###############
 
@@ -113,8 115,6 @@ Serving
 
 .. autoclass:: ray.serve.air_integrations.PredictorWrapper
 
-.. _air-results-ref:
-
 Trainer and Predictor Integrations
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/doc/source/ray-air/preprocessors.rst b/doc/source/ray-air/preprocessors.rst
@@ -92,7 92,7 @@ the ``Preprocessor`` and the fitting and transformation logic will occur once pe
 Checkpoint
 ~~~~~~~~~~
 
-``Trainer.fit()`` returns a ``Results`` object which contains a ``Checkpoint``.
 ``Trainer.fit()`` returns a ``Result`` object which contains a ``Checkpoint``.
 If a ``Preprocessor`` was passed into the ``Trainer``, then it will be saved in the ``Checkpoint`` along with any fitted state.
 
 As a sanity check, let's confirm the ``Preprocessor`` is available in the ``Checkpoint``. In practice you should not need to do this.