Make the C++ interface easier to use #185
Draft
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds a more convenient way to index into tensors from the C++ API.
Previously, a user would have to explicitly compute an offset based on the strides of a tensor and their desired index (or use an external library).
They would also have to use different methods for string tensors and numeric tensors (e.g.
get_string
/set_string
for dealing with string tensors).This PR provides an
at
method that lets users pass in an index and get an element. It also provides anaccessor
method that can be used when accessing several elements. These work for both string and numeric tensors.Note: this is a breaking change for the following reasons:
get_string
andset_string
in the C++ API are now private methodscarton_tensor_get_string
,carton_tensor_set_string
, andcarton_tensor_set_string_with_strlen
from the C API now expect theirindex
argument to take strides into account. This shouldn't have a practical impact as all our current ways of creating string tensors and exposing them via the C API create tensors with standard strides.