Skip to content

Commit 0c9af91

Browse files
authored
Fixing some doc links (aws#143)
1 parent 977e379 commit 0c9af91

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/analysis.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -141,15 +141,15 @@ All arguments to this method are optional. You are not required to pass any of t
141141

142142

143143
#### 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).
145145
```python
146146
trial.tensor(tname)
147147
```
148148
###### Arguments
149149
- `tname (str)` Takes the name of tensor
150150

151151
###### 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)
153153

154154
#### has_tensor
155155
Query whether the trial has a tensor by the given name
@@ -243,7 +243,7 @@ trial.collections()
243243
```
244244

245245
###### 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.
247247

248248
#### collection
249249

@@ -256,7 +256,7 @@ trial.collection(coll_name)
256256
- `coll_name (str)` Name of the collection
257257

258258
###### 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.
260260

261261

262262
#### wait\_for\_steps
@@ -332,7 +332,7 @@ trial.tensor(name).value(step_num, mode=ModeKeys.GLOBAL, worker=None)
332332
`numpy.ndarray` The value of tensor at the given step and worker (if the training job saved data from multiple workers)
333333

334334
#### 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.
336336
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.
337337

338338
Reduction names allowed are `min`, `max`, `mean`, `prod`, `std`, `sum`, `variance` and `l1`, `l2` representing the norms.

0 commit comments

Comments
 (0)