Skip to content

fix docs examples for ForwardBackwardOutput metrics access #37

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

Open
lokashrinav wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix docs examples for ForwardBackwardOutput metrics access #37

Show file tree
Hide file tree
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
5 changes: 2 additions & 3 deletions docs/api/trainingclient.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ data = [types.Datum(
)]
future = training_client.forward(data, "cross_entropy")
result = await future
print(f"Loss: {result.loss}")
print(f"Loss: {result.metrics['loss:sum']}")
```

#### `forward_async`
Expand Down Expand Up @@ -108,7 +108,7 @@ optim_future = training_client.optim_step(
)

fwdbwd_result = await fwdbwd_future
print(f"Loss: {fwdbwd_result.loss}")
print(f"Loss: {fwdbwd_result.metrics['loss:sum']}")
```

#### `forward_backward_async`
Expand Down Expand Up @@ -157,7 +157,6 @@ def custom_loss(data, logprobs_list):

future = training_client.forward_backward_custom(data, custom_loss)
result = future.result()
print(f"Custom loss: {result.loss}")
print(f"Metrics: {result.metrics}")
```

Expand Down
5 changes: 2 additions & 3 deletions src/tinker/lib/public_interfaces/training_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ def forward(
)]
future = training_client.forward(data, "cross_entropy")
result = await future
print(f"Loss: {result.loss}")
print(f"Loss: {result.metrics['loss:sum']}")
```
"""
requests = self._chunked_requests(data)
Expand Down Expand Up @@ -294,7 +294,7 @@ def forward_backward(
)

fwdbwd_result = await fwdbwd_future
print(f"Loss: {fwdbwd_result.loss}")
print(f"Loss: {fwdbwd_result.metrics['loss:sum']}")
```
"""
requests = self._chunked_requests(data)
Expand Down Expand Up @@ -368,7 +368,6 @@ def custom_loss(data, logprobs_list):

future = training_client.forward_backward_custom(data, custom_loss)
result = future.result()
print(f"Custom loss: {result.loss}")
print(f"Metrics: {result.metrics}")
```
"""
Expand Down