Merge pull request #2 from j3soon/hparams

Add support for hparams and fix empty directory bug

Author: j3soon

README.md

@@ -75,3 +75,11 @@ Generate test coverage:
 python3 -m pip install pandas tensorflow torch tensorboardX pytest pytest-cov
 python3 -m pytest --cov=./ --cov-report html
 ```
+
+## License
+
+tbparse is distributed under the [MIT License](LICENSE).
+
+The tbparse PyPI package depends upon (imports) the following third-party package. Each third-party software package is provided under its own license:
+- [pandas](https://github.com/pandas-dev/pandas) is distributed under the [BSD-3-Clause License ](https://github.com/pandas-dev/pandas/blob/main/LICENSE)
+- [tensorboard](https://github.com/tensorflow/tensorboard) is distributed under the [Apache License 2.0](https://github.com/tensorflow/tensorboard/blob/master/LICENSE)

docs/pages/parsing-histograms.rst

@@ -58,7 +58,7 @@ event files are generated by three commonly used event log writers.
 
          >>> from tbparse import SummaryReader
          >>> SummaryReader(log_dir, pivot=True).histograms.columns
-         Index(['step', 'dist/limits', 'dist/counts'], dtype='object')
+         Index(['step', 'dist/counts', 'dist/limits'], dtype='object')
 
    .. group-tab:: TensorFlow / Keras
 
@@ -112,7 +112,7 @@ event files are generated by three commonly used event log writers.
 
          >>> from tbparse import SummaryReader
          >>> SummaryReader(log_dir, pivot=True).histograms.columns
-         Index(['step', 'dist/limits', 'dist/counts'], dtype='object')
+         Index(['step', 'dist/counts', 'dist/limits'], dtype='object')
 
 Parsing Event Logs
 ===================================
@@ -139,9 +139,9 @@ Load File / Directory
          >>> from tbparse import SummaryReader
          >>> log_dir = tmpdirs['torch'].name
          >>> SummaryReader(log_dir).histograms.columns # wide format
-         Index(['step', 'tag', 'limits', 'counts'], dtype='object')
+         Index(['step', 'tag', 'counts', 'limits'], dtype='object')
          >>> SummaryReader(log_dir, pivot=True).histograms.columns # long format
-         Index(['step', 'dist/limits', 'dist/counts'], dtype='object')
+         Index(['step', 'dist/counts', 'dist/limits'], dtype='object')
 
    .. group-tab:: TensorFlow / Keras