Skip to content
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.

Sign up for GitHub

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

Jump to bottom

NOISSUE: Add Documentation for Running Algo with Args #41

Merged
merged 4 commits into from
Sep 11, 2024
Merged

NOISSUE: Add Documentation for Running Algo with Args #41

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
25506d8
add args documentation
WashingtonKK Aug 29, 2024
912e596
add full docs for args
WashingtonKK Aug 29, 2024
9b32ec1
fix: typo
WashingtonKK Sep 10, 2024
03510b2
fix typo
WashingtonKK Sep 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/algorithms.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not only python arguments are for all algos


```bash
./build/cocos-cli algo ./test/manual/algo/addition.py ./private.pem -a python --args="--a" --args="100" --args="--b" --args="20"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

```

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Port this documentation to here since this is the main documentation place


## Docker

Docker is a platform designed to build, share, and run containerized applications. A container packages the application code, runtime, system tools, libraries, and all necessary settings into a single unit. This ensures the container can be reliably transferred between different computing environments and be executed as expected.
Expand Down