Fix return type in docs #194
Merged
Conversation
This file contains 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
jmoreira-valory
commented
Mar 21, 2024
| ## Build your own | ||
|
|
||
| You can create and mint your own AI Mech that handles requests for tasks that you can define. | ||
|
|
||
| 1. **Create a new tool.** Tools are the components that execute the Requests for AI tasks submitted on [Mech Hub](https://aimechs.autonolas.network/mech). Tools are custom components and should be under the `customs` packages (ex. [valory tools](./packages/valory/customs)). Such file must contain a `run` function satisfying the following interface: | ||
|
|
||
| ```python | ||
| def run(**kwargs) -> Tuple[Optional[str], Optional[Dict[str, Any]], Any, Any]:: | ||
| def run(**kwargs) -> Tuple[str, Optional[str], Optional[Dict[str, Any]], Any]: |
There was a problem hiding this comment.
@0xArdi verify
jmoreira-valory
commented
Mar 21, 2024
| @@ -217,7 +223,7 @@ You can create and mint your own AI Mech that handles requests for tasks that yo | |||
| <api_key>=kwargs["api_keys"][<api_key_id>]. | |||
| ``` | |||
|
|
|||
| - **Output**: It must **always** return a tuple (`Tuple[Optional[str], Any, Optional[Dict[str, Any]], Any]`): | |||
| - **Output**: It must **always** return a tuple (`Tuple[str, Optional[str], Optional[Dict[str, Any]], Any]`): | |||
There was a problem hiding this comment.
@0xArdi verify
0xArdi
approved these changes
Mar 21, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fix return type in docs