Skip to content
This repository was archived by the owner on Jan 6, 2023. It is now read-only.

Commit dae09a6

Browse files
Kiuk Chungfacebook-github-bot
authored andcommitted
branch cut v0.2.2 + fix doc gen for events
Summary: Releasing torchelastic-0.2.2 Reviewed By: tierex Differential Revision: D26475562 fbshipit-source-id: 2873926c703a0cf3ac0b52c03bfbd919365fb7f0
1 parent 50dc44a commit dae09a6

File tree

3 files changed

+13
-16
lines changed

3 files changed

+13
-16
lines changed

docs/source/events.rst

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,23 @@ Events
55

66
.. automodule:: torchelastic.events
77

8-
Event Handlers
9-
-----------------
8+
API Methods
9+
------------
1010

11-
.. currentmodule:: torchelastic.events.api
11+
.. autofunction:: torchelastic.events.record
1212

13-
.. autoclass:: Event
13+
.. autofunction:: torchelastic.events.get_logging_handler
1414

15-
.. autoclass:: EventHandler
15+
Event Objects
16+
-----------------
1617

17-
.. autoclass:: ConsoleEventHandler
18+
.. currentmodule:: torchelastic.events.api
1819

19-
.. autoclass:: NullEventHandler
20+
.. autoclass:: Event
2021

22+
.. autoclass:: EventSource
2123

22-
API Methods
23-
------------
24+
.. autoclass:: EventMetadataValue
2425

25-
.. autofunction:: torchelastic.events.configure
2626

27-
.. autofunction:: torchelastic.events.record
2827

29-
.. autofunction:: torchelastic.events.record_event

torchelastic/events/api.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@
66
# This source code is licensed under the BSD-style license found in the
77
# LICENSE file in the root directory of this source tree.
88

9-
import abc
109
import json
11-
from dataclasses import dataclass, field, asdict
10+
from dataclasses import asdict, dataclass, field
1211
from enum import Enum
13-
from typing import Dict, Union, Optional
12+
from typing import Dict, Optional, Union
1413

1514

1615
EventMetadataValue = Union[str, int, float, bool, None]

torchelastic/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@
1515
# 0.1.0bN # Beta release
1616
# 0.1.0rcN # Release Candidate
1717
# 0.1.0 # Final release
18-
__version__ = "0.2.2rc0"
18+
__version__ = "0.2.2"

0 commit comments

Comments
 (0)