Skip to content

Commit edd0541

Browse files
authored
add deprecated decorator for paddle.utils.profiler (#50134)
1 parent 4c82e45 commit edd0541

File tree

1 file changed

+48
-16
lines changed

1 file changed

+48
-16
lines changed

python/paddle/utils/profiler.py

Lines changed: 48 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,27 @@
2323
from ..fluid.profiler import profiler # noqa: F401
2424
from ..fluid.profiler import stop_profiler
2525
from ..fluid.profiler import reset_profiler
26-
27-
__all__ = [ #noqa
28-
'Profiler', 'get_profiler', 'ProfilerOptions', 'cuda_profiler',
29-
'start_profiler', 'profiler', 'stop_profiler', 'reset_profiler'
26+
from .deprecated import deprecated
27+
28+
__all__ = [ # noqa
29+
'Profiler',
30+
'get_profiler',
31+
'ProfilerOptions',
32+
'cuda_profiler',
33+
'start_profiler',
34+
'profiler',
35+
'stop_profiler',
36+
'reset_profiler',
3037
]
3138

3239

40+
@deprecated(
41+
since="2.4.2",
42+
update_to="paddle.profiler.Profiler",
43+
level=1,
44+
reason="Please use new profiler tool, this profiler tool is no longer maintained.",
45+
)
3346
class ProfilerOptions(object):
34-
3547
def __init__(self, options=None):
3648
self.options = {
3749
'state': 'All',
@@ -41,7 +53,7 @@ def __init__(self, options=None):
4153
'output_thread_detail': False,
4254
'profile_path': 'none',
4355
'timeline_path': 'none',
44-
'op_summary_path': 'none'
56+
'op_summary_path': 'none',
4557
}
4658
if options is not None:
4759
for key in self.options.keys():
@@ -56,10 +68,13 @@ def with_state(self, state):
5668
def __getitem__(self, name):
5769
if self.options.get(name, None) is None:
5870
raise ValueError(
59-
"ProfilerOptions does not have an option named %s." % name)
71+
"ProfilerOptions does not have an option named %s." % name
72+
)
6073
else:
61-
if isinstance(self.options[name],
62-
str) and self.options[name] == 'none':
74+
if (
75+
isinstance(self.options[name], str)
76+
and self.options[name] == 'none'
77+
):
6378
return None
6479
else:
6580
return self.options[name]
@@ -68,8 +83,13 @@ def __getitem__(self, name):
6883
_current_profiler = None
6984

7085

86+
@deprecated(
87+
since="2.4.2",
88+
update_to="paddle.profiler.Profiler",
89+
level=1,
90+
reason="Please use new profiler tool, this profiler tool is no longer maintained.",
91+
)
7192
class Profiler(object):
72-
7393
def __init__(self, enabled=True, options=None):
7494
if options is not None:
7595
self.profiler_options = options
@@ -101,22 +121,28 @@ def start(self):
101121
try:
102122
start_profiler(
103123
state=self.profiler_options['state'],
104-
tracer_option=self.profiler_options['tracer_level'])
124+
tracer_option=self.profiler_options['tracer_level'],
125+
)
105126
except Exception as e:
106127
warnings.warn(
107-
"Profiler is not enabled becuase following exception:\n{}".
108-
format(e))
128+
"Profiler is not enabled becuase following exception:\n{}".format(
129+
e
130+
)
131+
)
109132

110133
def stop(self):
111134
if self.enabled:
112135
try:
113136
stop_profiler(
114137
sorted_key=self.profiler_options['sorted_key'],
115-
profile_path=self.profiler_options['profile_path'])
138+
profile_path=self.profiler_options['profile_path'],
139+
)
116140
except Exception as e:
117141
warnings.warn(
118-
"Profiler is not disabled becuase following exception:\n{}".
119-
format(e))
142+
"Profiler is not disabled becuase following exception:\n{}".format(
143+
e
144+
)
145+
)
120146

121147
def reset(self):
122148
if self.enabled and core.is_profiler_enabled():
@@ -137,6 +163,12 @@ def record_step(self, change_profiler_status=True):
137163
self.stop()
138164

139165

166+
@deprecated(
167+
since="2.4.2",
168+
update_to="paddle.profiler.Profiler",
169+
level=1,
170+
reason="Please use new profiler tool, this profiler tool is no longer maintained.",
171+
)
140172
def get_profiler():
141173
global _current_profiler
142174
if _current_profiler is None:

0 commit comments

Comments
 (0)