-
Notifications
You must be signed in to change notification settings - Fork 84
[Backline] fix transport/executor dialect docs #3197
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.
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
d1e9a07
init commit
multiphaseCFD 163c367
revert changes in mlir path only keep the changes made to transport d…
multiphaseCFD d91188f
revert changes in doc
multiphaseCFD 13e94e9
reorder transport dialect sections
multiphaseCFD ead8677
update banner: manually added
multiphaseCFD b90d3db
update styles/formator
multiphaseCFD 1f1d195
add links in trans
multiphaseCFD d8129b9
descriptor to match quantum dialect
multiphaseCFD 7fd470c
add an changelog entry
multiphaseCFD 1aef740
Update doc/code/dialects/Executor/ExecutorDialect.md
multiphaseCFD 5b36203
Apply suggestion from @multiphaseCFD
multiphaseCFD f2e02a3
triger CIs
multiphaseCFD e3ac745
Update doc/code/dialects/Executor/ExecutorDialect.md
multiphaseCFD edf1521
Update doc/code/dialects/Transport/TransportDialect.md
multiphaseCFD efc92cd
Update doc/code/dialects/Executor/ExecutorDialect.md
multiphaseCFD File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| <!-- Autogenerated by mlir-tblgen; don't manually edit --> | ||
|
|
||
| ### BacklineAttr | ||
|
|
||
| _A backline placement: one controller and the coprocessors it drives._ | ||
|
|
||
| Syntax: | ||
|
|
||
| ``` | ||
| #transport.backline< | ||
| mlir::StringAttr, # transport | ||
| ::catalyst::transport::NodeAttr, # controller | ||
| ::llvm::ArrayRef<::catalyst::transport::NodeAttr> # coprocessors | ||
| > | ||
| ``` | ||
|
|
||
| #### Parameters: | ||
|
|
||
| | Parameter | C++ type | Description | | ||
| | :-------: | :-------: | ----------- | | ||
| | transport | `mlir::StringAttr` | transport carrying the traffic, selecting the compiled backend | | ||
| | controller | `::catalyst::transport::NodeAttr` | the controller node that drives the session | | ||
| | coprocessors | `::llvm::ArrayRef<::catalyst::transport::NodeAttr>` | the coprocessor nodes the controller drives | | ||
|
|
||
| ### NodeAttr | ||
|
|
||
| _A backline participant: a controller or a coprocessor._ | ||
|
|
||
| Syntax: | ||
|
|
||
| ``` | ||
| #transport.node< | ||
| mlir::StringAttr, # name | ||
| mlir::StringAttr, # peer | ||
| mlir::IntegerAttr, # oob_port | ||
| mlir::StringAttr, # backend_lib | ||
| mlir::StringAttr, # config | ||
| mlir::StringAttr, # triple | ||
| mlir::StringAttr, # address | ||
| mlir::StringAttr, # symbol | ||
| mlir::BoolAttr, # out_of_process | ||
| mlir::IntegerAttr, # in_bytes | ||
| mlir::IntegerAttr, # out_bytes | ||
| mlir::IntegerAttr # work_item_idx | ||
| > | ||
| ``` | ||
|
|
||
| #### Parameters: | ||
|
|
||
| | Parameter | C++ type | Description | | ||
| | :-------: | :-------: | ----------- | | ||
| | name | `mlir::StringAttr` | this node's name; the session registry key when non-empty | | ||
| | peer | `mlir::StringAttr` | the peer's address for the out-of-band handshake | | ||
| | oob_port | `mlir::IntegerAttr` | TCP port for the out-of-band handshake | | ||
| | backend_lib | `mlir::StringAttr` | backend plugin the runtime dlopens for this node | | ||
| | config | `mlir::StringAttr` | backend configuration string, passed through verbatim | | ||
| | triple | `mlir::StringAttr` | target triple this node's code is compiled for | | ||
| | address | `mlir::StringAttr` | executor address when this node runs out of process | | ||
| | symbol | `mlir::StringAttr` | coprocessor function symbol the backend binds | | ||
| | out_of_process | `mlir::BoolAttr` | whether this node's code is dispatched to an executor rather than run in the compiling process | | ||
| | in_bytes | `mlir::IntegerAttr` | request size in bytes for one round | | ||
| | out_bytes | `mlir::IntegerAttr` | reply size in bytes for one round | | ||
| | work_item_idx | `mlir::IntegerAttr` | index of this node's work item within the round | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| <!-- Autogenerated by mlir-tblgen; don't manually edit --> | ||
|
|
||
| ### SessionType | ||
|
|
||
| _An opaque transport session handle, tagged with its role._ | ||
|
|
||
| Syntax: | ||
|
|
||
| ``` | ||
| !transport.session< | ||
| ::catalyst::transport::Role # role | ||
| > | ||
| ``` | ||
|
|
||
| #### Parameters: | ||
|
|
||
| | Parameter | C++ type | Description | | ||
| | :-------: | :-------: | ----------- | | ||
| | role | `::catalyst::transport::Role` | an enum of type Role | | ||
|
|
||
| ### TokenType | ||
|
|
||
| _A handle to an in-flight asynchronous step, awaited with transport.await._ | ||
|
|
||
| Syntax: `!transport.token` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.