Skip to content

Commit 872f95f

Browse files
kunalbfacebook-github-bot
authored andcommitted
Correct capitalization, TensorBoard not Tensorboard
Summary: X-link: facebookresearch/d2go#502 fbgs TensorboardXWriter -l -s | xargs sed -i "s/TensorboardXWriter/TensorBoardXWriter/g" Reviewed By: wat3rBro Differential Revision: D43863403 fbshipit-source-id: 9030e59b585a8ee8e8ee76cf7ce7a1da9f597700
1 parent 703cb03 commit 872f95f

File tree

3 files changed

+9
-10
lines changed

3 files changed

+9
-10
lines changed

detectron2/engine/defaults.py

+3-3
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040
from detectron2.utils import comm
4141
from detectron2.utils.collect_env import collect_env_info
4242
from detectron2.utils.env import seed_all_rng
43-
from detectron2.utils.events import CommonMetricPrinter, JSONWriter, TensorboardXWriter
43+
from detectron2.utils.events import CommonMetricPrinter, JSONWriter, TensorBoardXWriter
4444
from detectron2.utils.file_io import PathManager
4545
from detectron2.utils.logger import setup_logger
4646

@@ -231,7 +231,7 @@ def default_writers(output_dir: str, max_iter: Optional[int] = None):
231231
"""
232232
Build a list of :class:`EventWriter` to be used.
233233
It now consists of a :class:`CommonMetricPrinter`,
234-
:class:`TensorboardXWriter` and :class:`JSONWriter`.
234+
:class:`TensorBoardXWriter` and :class:`JSONWriter`.
235235
236236
Args:
237237
output_dir: directory to store JSON metrics and tensorboard events
@@ -245,7 +245,7 @@ def default_writers(output_dir: str, max_iter: Optional[int] = None):
245245
# It may not always print what you want to see, since it prints "common" metrics only.
246246
CommonMetricPrinter(max_iter),
247247
JSONWriter(os.path.join(output_dir, "metrics.json")),
248-
TensorboardXWriter(output_dir),
248+
TensorBoardXWriter(output_dir),
249249
]
250250

251251

detectron2/utils/events.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
__all__ = [
1717
"get_event_storage",
1818
"JSONWriter",
19-
"TensorboardXWriter",
19+
"TensorBoardXWriter",
2020
"CommonMetricPrinter",
2121
"EventStorage",
2222
]
@@ -129,7 +129,7 @@ def close(self):
129129
self._file_handle.close()
130130

131131

132-
class TensorboardXWriter(EventWriter):
132+
class TensorBoardXWriter(EventWriter):
133133
"""
134134
Write all scalars to a tensorboard file.
135135
"""

tests/utils/test_tensorboardx.py

+4-5
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,20 @@
22
import tempfile
33
import unittest
44

5-
from detectron2.utils.events import TensorboardXWriter
5+
from detectron2.utils.events import TensorBoardXWriter
66

77

8-
# TODO Fix up capitalization
9-
class TestTensorboardXWriter(unittest.TestCase):
8+
class TestTensorBoardXWriter(unittest.TestCase):
109
def test_no_files_created(self) -> None:
1110
with tempfile.TemporaryDirectory() as dir:
12-
writer = TensorboardXWriter(dir)
11+
writer = TensorBoardXWriter(dir)
1312
writer.close()
1413

1514
self.assertFalse(os.listdir(dir))
1615

1716
def test_single_write(self) -> None:
1817
with tempfile.TemporaryDirectory() as dir:
19-
writer = TensorboardXWriter(dir)
18+
writer = TensorBoardXWriter(dir)
2019
writer._writer.add_scalar("testing", 1, 1)
2120
writer.close()
2221

0 commit comments

Comments
 (0)