Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fixing some doc links #143

Merged
merged 1 commit into from
Jan 10, 2020
Merged

Fixing some doc links #143

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/analysis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,15 +141,15 @@ All arguments to this method are optional. You are not required to pass any of t


#### tensor
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).
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).
```python
trial.tensor(tname)
```
###### Arguments
- `tname (str)` Takes the name of tensor

###### Returns
`smdebug.core.tensor.Tensor` object which has [this API](api.md#Tensor-1)
`smdebug.core.tensor.Tensor` object which has [this API](#Tensor-1)

#### has_tensor
Query whether the trial has a tensor by the given name
Expand Down Expand Up @@ -243,7 +243,7 @@ trial.collections()
```

###### Returns
`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.
`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.

#### collection

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

###### Returns
`Collection` The requested Collection object. Please refer [Collection API](api.md) for more details. #TODO fix link
`Collection` The requested Collection object. Please refer [Collection API](api.md#Collection) for more details.


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

#### reduction_value
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.
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.
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.

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