Skip to content

Commit 78f808b

Browse files
committed
docs: update docs with binding name restrictions
Signed-off-by: Naren Dasan <[email protected]> Signed-off-by: Naren Dasan <[email protected]>
1 parent 819c911 commit 78f808b

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

cpp/include/torch_tensorrt/torch_tensorrt.h

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -739,7 +739,12 @@ TORCHTRT_API std::string convert_method_to_trt_engine(
739739
* module. Registers execution of the engine as the forward method of the module
740740
* Forward is defined as: forward(Tensor[]) -> Tensor[]
741741
*
742-
* @return: A new module trageting a TensorRT engine
742+
* TensorRT bindings must have names with the following format:
743+
* - [symbol].[index in input / output array]
744+
* ex.
745+
* - [x.0, x.1, x.2] -> [y.0]
746+
*
747+
* @return: A new module targeting a TensorRT engine
743748
*/
744749
TORCHTRT_API torch::jit::Module embed_engine_in_new_module(const std::string& engine, Device device);
745750
} // namespace torchscript

0 commit comments

Comments
 (0)