Skip to content

Commit e0824e2

Browse files
committed
Clarify about smdebug config
1 parent b841cc1 commit e0824e2

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

documentation/API.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -283,15 +283,16 @@ if the user doesn't want to use SageMaker Debugger.
283283

284284
####`SMDEBUG_CONFIG_FILE_PATH`:
285285

286-
Contains the path to the JSON file that describes the smdebug hook. SageMaker-Debugger is disabled
287-
if this environment variable is not set.
286+
Contains the path to the JSON file that describes the smdebug hook.
288287

289288
At the minimum, the JSON config should contain the path where smdebug should output tensors.
290289
Example:
291290

292291
`{ “LocalPath”: /my/smdebug_hook/path }`
293292

294-
In SageMaker environment, this path is set to point to a pre-defined location.
293+
In SageMaker environment, this path is set to point to a pre-defined location containing a valid JSON.
294+
In non-SageMaker environment, SageMaker-Debugger is not used if this environment variable is not set and
295+
a hook is not created manually.
295296

296297
Sample JSON from which a hook can be created:
297298
```

0 commit comments

Comments
 (0)