You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/analysis.md
+5-5Lines changed: 5 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -141,15 +141,15 @@ All arguments to this method are optional. You are not required to pass any of t
141
141
142
142
143
143
#### tensor
144
-
Retrieve the `smdebug.core.tensor.Tensor` object by the given name `tname`. You can review all the methods that this Tensor object provides [here](api.md#Tensor-1).
144
+
Retrieve the `smdebug.core.tensor.Tensor` object by the given name `tname`. You can review all the methods that this Tensor object provides [here](#Tensor-1).
145
145
```python
146
146
trial.tensor(tname)
147
147
```
148
148
###### Arguments
149
149
-`tname (str)` Takes the name of tensor
150
150
151
151
###### Returns
152
-
`smdebug.core.tensor.Tensor` object which has [this API](api.md#Tensor-1)
152
+
`smdebug.core.tensor.Tensor` object which has [this API](#Tensor-1)
153
153
154
154
#### has_tensor
155
155
Query whether the trial has a tensor by the given name
@@ -243,7 +243,7 @@ trial.collections()
243
243
```
244
244
245
245
###### Returns
246
-
`dict[str -> Collection]` A dictionary indexed by the name of the collection, with the Collection object as the value. Please refer [Collection API](https://github.com/awslabs/sagemaker-debugger/blob/master/docs/api.md#Collection) for more details.
246
+
`dict[str -> Collection]` A dictionary indexed by the name of the collection, with the Collection object as the value. Please refer [Collection API](api.md#Collection) for more details.
247
247
248
248
#### collection
249
249
@@ -256,7 +256,7 @@ trial.collection(coll_name)
256
256
-`coll_name (str)` Name of the collection
257
257
258
258
###### Returns
259
-
`Collection` The requested Collection object. Please refer [Collection API](api.md) for more details. #TODO fix link
259
+
`Collection` The requested Collection object. Please refer [Collection API](api.md#Collection) for more details.
`numpy.ndarray` The value of tensor at the given step and worker (if the training job saved data from multiple workers)
333
333
334
334
#### reduction_value
335
-
Get the reduction value of the chosen tensor at a particular step. A reduction value is a tensor reduced to a single value through reduction or aggregation operations. The different reductions you can query for are the same as what are allowed in [ReductionConfig](https://github.com/awslabs/sagemaker-debugger/blob/master/docs/api.md) when saving tensors.
335
+
Get the reduction value of the chosen tensor at a particular step. A reduction value is a tensor reduced to a single value through reduction or aggregation operations. The different reductions you can query for are the same as what are allowed in [ReductionConfig](api.md#reductionconfig) when saving tensors.
336
336
This API thus allows you to access the reduction you might have saved instead of the full tensor. If you had saved the full tensor, it will calculate the requested reduction at the time of this call.
337
337
338
338
Reduction names allowed are `min`, `max`, `mean`, `prod`, `std`, `sum`, `variance` and `l1`, `l2` representing the norms.
0 commit comments