Skip to content

Commit

Permalink
Annotated in/out arguments for create_device/create_stream_executor
Browse files Browse the repository at this point in the history
We should probably annotate all functions in the C API to clarify inputs and outputs. I will do that when implementing.
  • Loading branch information
annarev committed Jul 14, 2020
1 parent f824058 commit 3fde302
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions rfcs/20200612-stream-executor-c-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,11 +329,16 @@ typedef struct SE_PlatformParams {
size_t type_len;

// Callbacks for creating/destroying.
void (*create_device)(SE_Device* device, SE_Options* options, TF_Status* status);
void (*create_device)(
SE_Device* device, \\ out
SE_Options* options, \\ in
TF_Status* status); \\ out
void (*destroy_device)(SE_Device* device);

// Callbacks for creating/destroying SE_StreamExecutor.
void (*create_stream_executor)(SE_StreamExecutor*, TF_Status* status);
void (*create_stream_executor)(
SE_StreamExecutor*, \\ out
TF_Status* status); \\ out
void (*destroy_stream_executor)(SE_StreamExecutor* stream_executor);
} SE_PlatformParams;

Expand Down

0 comments on commit 3fde302

Please sign in to comment.