mirror of
https://github.com/ROCm/jax.git
synced 2025-04-17 04:16:07 +00:00
78 lines
2.1 KiB
Python
78 lines
2.1 KiB
Python
# Copyright 2025 The JAX Authors.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# https://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
"""Utilities for profiling, abstracting over jax.profiler and nsys."""
|
|
|
|
from contextlib import contextmanager
|
|
import os
|
|
|
|
import jax
|
|
|
|
|
|
def get_profiling_mode() -> str | None:
|
|
mode = os.environ.get('PROFILE')
|
|
if mode is not None:
|
|
mode = mode.lower()
|
|
assert mode in ('jax', 'nsys')
|
|
return mode
|
|
return None
|
|
|
|
|
|
if get_profiling_mode() == 'nsys':
|
|
from ctypes import cdll
|
|
libcudart = cdll.LoadLibrary('libcudart.so')
|
|
import nvtx # type: ignore[import-not-found]
|
|
|
|
|
|
def maybe_start_profile(path):
|
|
profiling_mode = get_profiling_mode()
|
|
if profiling_mode is None:
|
|
pass
|
|
elif profiling_mode == 'jax':
|
|
jax.profiler.start_trace(path)
|
|
elif profiling_mode == 'nsys':
|
|
libcudart.cudaProfilerStart()
|
|
else:
|
|
assert False
|
|
|
|
|
|
def maybe_stop_profile():
|
|
profiling_mode = get_profiling_mode()
|
|
if profiling_mode is None:
|
|
pass
|
|
elif profiling_mode == 'jax':
|
|
try:
|
|
jax.profiler.stop_trace()
|
|
except RuntimeError as e:
|
|
if e.args[0] != 'No profile started':
|
|
raise
|
|
elif profiling_mode == 'nsys':
|
|
libcudart.cudaProfilerStop()
|
|
else:
|
|
assert False
|
|
|
|
|
|
@contextmanager
|
|
def annotate(label, color=None):
|
|
profiling_mode = get_profiling_mode()
|
|
if profiling_mode is None:
|
|
yield
|
|
elif profiling_mode == 'jax':
|
|
with jax.profiler.TraceAnnotation(label):
|
|
yield
|
|
elif profiling_mode == 'nsys':
|
|
with nvtx.annotate(label, color=color or 'red'):
|
|
yield
|
|
else:
|
|
assert False
|