Skip to content

Commit

Permalink
Update documentation and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
ankitgola005 committed Mar 6, 2024
1 parent 68250d0 commit 5b7c83c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Added

- Added support for Intel Gaudi Profiler. Deprecate `HABANA_PROFILE` environment variable from HPUProfiler. ([#158](https://github.com/Lightning-AI/lightning-Habana/pull/158))
-

### Changed
Expand Down
14 changes: 14 additions & 0 deletions docs/source/advanced.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,20 @@ Limitations

- Passing the Profiler name as a string "hpu" to the trainer is not supported.

----

Using Intel Gaudi Profiler
------------------------------

The Intel Gaudi Profiling subsystem, and the Profiling Configuration tools are methods to configure Intel Gaudi Profiler.

Please refer to `Getting Started with Intel Gaudi Profiler <https://docs.habana.ai/en/latest/Profiling/Intel_Gaudi_Profiling/Getting_Started_with_Profiler.html>`_ for more information.

.. note::

``HPUProfiler`` and Intel Gaudi Profiler should not be used together. Therefore, `HABANA_PROFILE` should not be set in environment when using ``HPUProfiler``.


----

Using DeepSpeed
Expand Down
1 change: 0 additions & 1 deletion tests/test_pytorch/test_profiler.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,6 @@ def test_hpu_trace_event_runtime(tmpdir):
assert event_duration >= 0


@pytest.mark.xfail(strict=False, reason="TBF: Could not find event kernel in trace")
def test_hpu_trace_event_kernel(tmpdir):
# Run model and prep json
model = BoringModel()
Expand Down

0 comments on commit 5b7c83c

Please sign in to comment.