Make small improvements to the events documentation

Summary: Make small improvements to the events documentation

Reviewed By: kiukchung

Differential Revision: D21241412

fbshipit-source-id: 6ec772918b9a2767c787f9a129ae5ffa790a0a40

Author: aivanou

docs/source/customization.rst

@@ -89,6 +89,9 @@ Events Handler
 -----------------------------
 
 TorchElastic supports events recording (see :ref:`events-api`).
+The events module defines API that allows you to record events and
+implement custom EventHandler. EventHandler is used for publishing events
+produced during torchelastic execution to different sources, e.g.  AWS CloudWatch.
 By default it uses `torchelastic.events.NullEventHandler` that ignores
 events. To configure custom events handler you need to implement
 `torchelastic.events.EventHandler` interface and `configure` it

torchelastic/events/__init__.py

@@ -13,7 +13,8 @@
 The event API is used to publish and process events. The module can be used
 to capture state transitions to debug or give insight into the execution
 flow. The :py:class:`torchelastic.events.Event` is an object containing information
-about an occurrence during the execution of the program.
+about an occurrence during the execution of the program. The destination handler
+for events can be configured by the event type parameter.
 
 
 .. note:: The event type ``torchelastic`` is reserved by torchelastic for
@@ -26,7 +27,7 @@
 of usage and consists of two parts: handler configuration and event publishing.
 
 The example below shows the simple event publishing mechanism
-via :py:meth:`torchelastic.events.record_record` method.
+via :py:meth:`torchelastic.events.record_event` method.
 
 ::