NOISSUE: Add Documentation for Running Algo with Args #41
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
Signed-off-by: WashingtonKK <[email protected]>
rodneyosodo
requested changes
Aug 29, 2024
docs/algorithms.md
Outdated
| ./build/cocos-cli algo ./test/manual/algo/addition.py ./private.pem -a python --args="--a" --args="100" --args="--b" --args="20" | ||
| ``` | ||
|
|
||
| Details of how to run the full addition example with args can be found [here](https://github.com/ultravioletrs/cocos/blob/7a2789fb5fda48282ef0c1d516aa8ba36421f5f1/test/manual/algo/README.md). |
There was a problem hiding this comment.
Port this documentation to here since this is the main documentation place
SammyOina
requested changes
Aug 29, 2024
docs/algorithms.md
Outdated
| @@ -477,6 +477,16 @@ Terminal recording session | |||
|
|
|||
| For real-world examples to test with cocos, see our [AI repository](https://github.com/ultravioletrs/ai). | |||
|
|
|||
| ## Running Python Algorithms with arguments | |||
|
|
|||
| To run a python algo that requires command line arguments, you can append the algo command on cli with the arguments needed as shown in the addition example: | |||
There was a problem hiding this comment.
not only python arguments are for all algos
| To run a python algo that requires command line arguments, you can append the algo command on cli with the arguments needed as shown in the addition example: | ||
|
|
||
| ```bash | ||
| ./build/cocos-cli algo ./test/manual/algo/addition.py ./private.pem -a python --args="--a" --args="100" --args="--b" --args="20" |
There was a problem hiding this comment.
include more detail on how to add arguments, order, how may you need to add, show how the added args will be passed by agent to the algo
Signed-off-by: WashingtonKK <[email protected]> add full docs for args Signed-off-by: WashingtonKK <[email protected]>
SammyOina
requested changes
Sep 3, 2024
docs/algorithms.md
Outdated
| @@ -382,10 +382,10 @@ MANAGER_QEMU_OVMF_VARS_FILE=/usr/share/edk2/x64/OVMF_VARS.fd \ | |||
| go run main.go | |||
| ``` | |||
|
|
|||
| Export the agent grpc url from computation server logs | |||
| Export the agent grpc url from computation server logs, by default | |||
There was a problem hiding this comment.
this sentence sounds incomplete at the end
docs/algorithms.md
Outdated
| @@ -477,6 +477,65 @@ Terminal recording session | |||
|
|
|||
| For real-world examples to test with cocos, see our [AI repository](https://github.com/ultravioletrs/ai). | |||
|
|
|||
| ## Running Algorithms with arguments | |||
|
|
|||
| To run an algo that requires command line arguments, you can append the algo command on cli with the arguments needed as shown in the addition example, which we will run with args below: | |||
Signed-off-by: WashingtonKK <[email protected]>
SammyOina
requested changes
Sep 10, 2024
docs/algorithms.md
Outdated
| @@ -382,10 +382,10 @@ MANAGER_QEMU_OVMF_VARS_FILE=/usr/share/edk2/x64/OVMF_VARS.fd \ | |||
| go run main.go | |||
| ``` | |||
|
|
|||
| Export the agent grpc url from computation server logs | |||
| Export the agent grpc url from computation server logs, by default port 6100 will be used. If the port is not available, a different (random) port will be used, within the range 6100 - 6200. The port will be indicated on the computation server logs. | |||
Signed-off-by: WashingtonKK <[email protected]>
SammyOina
approved these changes
Sep 11, 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.
What type of PR is this?
This is an enhancement since it adds documentation for running an algo that requires command line args.
What does this do?
It adds documentation for running an algo that requires command line args.
Which issue(s) does this PR fix/relate to?
Have you included tests for your changes?
Not needed for docs.
Did you document any new/modified features?
Yes, this adds documentation for a feature in cocos.
Notes