Skip to content

Commit ed46cd1

Browse files
committed
fix pre-commit issue
1 parent e208443 commit ed46cd1

File tree

404 files changed

+3474
-3539
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

404 files changed

+3474
-3539
lines changed

.container/.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ GOOGLE_API_KEY=123456789
1515
SEARCH_ENGINE_ID=123456789
1616

1717
# For OpenWeatherMap API
18-
OPENWEATHERMAP_API_KEY=123456789
18+
OPENWEATHERMAP_API_KEY=123456789

.container/README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ develop on it, with Docker.
1111

1212
## Configure Environment
1313
Before starting the container, you need to navigate into the
14-
[.container](../.container) folder and create a `.env` file **with your own
15-
API
16-
keys**, so that these keys will be present in the environment variables of
17-
the container, which will later be used by CAMEL. The list of API keys that
14+
[.container](../.container) folder and create a `.env` file **with your own
15+
API
16+
keys**, so that these keys will be present in the environment variables of
17+
the container, which will later be used by CAMEL. The list of API keys that
1818
can be found in the `.env.example` file.
1919

2020
```bash
@@ -25,15 +25,15 @@ cp .env.example .env
2525
```
2626

2727
## Start Container
28-
After configuring the API keys, simply run the following command to start
28+
After configuring the API keys, simply run the following command to start
2929
up the working container. This will automatically set up the environment and
3030
dependencies for CAMEL. It may take some time, please be patient.
3131

3232
```bash
3333
docker compose up -d
3434
```
3535

36-
After the build is completed, you can see the image `camel:localdev` in the
36+
After the build is completed, you can see the image `camel:localdev` in the
3737
list of images, along with a started container, `camel-localdev`.
3838

3939
```bash
@@ -54,7 +54,7 @@ docker compose exec camel bash
5454
Then you will be in the container environment under the CAMEL directory, with
5555
all the dependencies installed.
5656

57-
Then You can try running the
57+
Then You can try running the
5858
[role_playing.py](../examples/ai_society/role_playing.py)
5959
example.
6060

@@ -66,43 +66,43 @@ If you see the agents interacting with each other, this means you are all set.
6666
Have fun with CAMEL in Docker!
6767

6868
## Save Your Progress
69-
We support volume mounting in the started container, which means that all
70-
of your changes in the CAMEL directory inside the container will be synced
69+
We support volume mounting in the started container, which means that all
70+
of your changes in the CAMEL directory inside the container will be synced
7171
into the CAMEL repo on your host system. Therefore, you don't need to worry
7272
about losing your progress when you exit the container.
7373

7474
## Exit, Stop and Delete the Container
7575
You can simply press `Ctrl + D` or use the `exit` command to exit the
7676
container.
7777

78-
After exiting the container, under normal cases the container will still be
79-
running in the background. If you don't need the container anymore, you can
78+
After exiting the container, under normal cases the container will still be
79+
running in the background. If you don't need the container anymore, you can
8080
stop and delete the container with the following command.
8181

8282
```bash
8383
docker compose down
8484
```
8585

8686
## Online Images
87-
For users who only want to have a quick tryout on CAMEL, we also provide the
87+
For users who only want to have a quick tryout on CAMEL, we also provide the
8888
pre-built images on
8989
[our GitHub Container Registry](https://github.com/camel-ai/camel/pkgs/container/camel).
90-
Considering the size of the image, we only offer the image with the basic
90+
Considering the size of the image, we only offer the image with the basic
9191
dependencies.
9292

93-
Note that there are some key differences between the local development
93+
Note that there are some key differences between the local development
9494
image and the pre-built image that you should be aware of.
95-
1. The pre-built image is built upon the source code of each release of CAMEL.
96-
This means that they are not suitable for development, as they don't
97-
contain the git support. If you want to develop on CAMEL, please build
95+
1. The pre-built image is built upon the source code of each release of CAMEL.
96+
This means that they are not suitable for development, as they don't
97+
contain the git support. If you want to develop on CAMEL, please build
9898
the image by yourself according to the instructions above.
99-
2. The pre-built image only contains the basic dependencies for running the
100-
examples. If you want to run the examples that require additional
101-
dependencies, you need to install them according to the
99+
2. The pre-built image only contains the basic dependencies for running the
100+
examples. If you want to run the examples that require additional
101+
dependencies, you need to install them according to the
102102
installation guide in CAMEL's [README](../README.md).
103-
3. The pre-built image doesn't contain the API keys. You need to set up the
103+
3. The pre-built image doesn't contain the API keys. You need to set up the
104104
API keys by yourself in the container environment.
105-
4. The pre-built image does not support volume mounting. This means that all
105+
4. The pre-built image does not support volume mounting. This means that all
106106
of your changes in the container will be lost when you delete the container.
107107

108108
To quickly start a container with the pre-built image, you can use the
@@ -123,4 +123,4 @@ command.
123123

124124
```bash
125125
python examples/ai_society/role_playing.py
126-
```
126+
```

.container/docker-compose.yaml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,3 @@ services:
1111
- .env
1212
user: "${UID:-1000}:${GID:-1000}"
1313
command: ["tail", "-f", "/dev/null"]
14-
15-

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,4 +140,4 @@
140140

141141
# Grok API key
142142
# XAI_API_KEY="Fill your Grok API Key here"
143-
# XAI_API_BASE_URL="Fill your Grok API Base URL here"
143+
# XAI_API_BASE_URL="Fill your Grok API Base URL here"

.github/workflows/test_minimal_dependency.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,4 @@ jobs:
4343
run: |
4444
source .venv/bin/activate
4545
pip install pytest dotenv
46-
pytest test/integration_test/test_minimal_dependency.py
46+
pytest test/integration_test/test_minimal_dependency.py

.pre-commit-config.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ repos:
2323
hooks:
2424
- id: check-license
2525
name: Check License
26-
entry: python licenses/update_license.py . licenses/license_template.txt
26+
entry: python licenses/update_license.py . licenses/license_template.txt
2727
language: system
2828
types: [python]
2929
exclude: ^(docs/cookbooks/|examples/usecases/) # Ignore files under docs/cookbooks and examples/usecases

CONTRIBUTING.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Thank you for your interest in contributing to the CAMEL project! 🎉 We're exc
44

55
## Join Our Community 🌍
66

7-
### Schedule an Introduction Call 📞
7+
### Schedule an Introduction Call 📞
88
- English speakers: [here](https://cal.com/wendong-fan-5yu7x5/30min)
99
- Chinese speakers: [here](https://cal.com/wendong-fan-5yu7x5/30min)
1010

@@ -21,7 +21,7 @@ Thank you for your interest in contributing to the CAMEL project! 🎉 We're exc
2121

2222
### Contributing to the Code 👨‍💻👩‍💻
2323

24-
If you're eager to contribute to this project, that's fantastic! We're thrilled to have your support.
24+
If you're eager to contribute to this project, that's fantastic! We're thrilled to have your support.
2525

2626
- If you are a contributor from the community:
2727
- Follow the [Fork-and-Pull-Request](https://docs.github.com/en/get-started/quickstart/contributing-to-projects) workflow when opening your pull requests.
@@ -40,9 +40,9 @@ Ensuring excellent documentation and thorough testing is absolutely crucial. Her
4040
- Update any affected example console scripts in the `examples` directory, Gradio demos in the `apps` directory, and documentation in the `docs` directory.
4141
- Update unit tests when relevant.
4242
- If you add a feature:
43-
- Include unit tests in the `test` directory.
43+
- Include unit tests in the `test` directory.
4444
- Add a demo script in the `examples` directory.
45-
45+
4646
We're a small team focused on building great things. If you have something in mind that you'd like to add or modify, opening a pull request is the ideal way to catch our attention. 🚀
4747

4848
### Contributing to the Cookbook Writing 📚
@@ -62,9 +62,9 @@ Here’s how you can contribute to writing cookbooks:
6262
- Interactive Elements: Whenever applicable, add interactive code cells in Colab that users can directly run and modify.
6363

6464
##### 1.2. Developing cookbooks for in-progress features
65-
You can install the latest version of CAMEL from the main branch or a topic branch. This allows you to use the latest codebase, or in-progress features in your cookbook.
65+
You can install the latest version of CAMEL from the main branch or a topic branch. This allows you to use the latest codebase, or in-progress features in your cookbook.
6666

67-
`!pip install "git+https://github.com/camel-ai/camel.git@master#egg=camel-ai[all]"`
67+
`!pip install "git+https://github.com/camel-ai/camel.git@master#egg=camel-ai[all]"`
6868

6969
Changing the branch and extras section (e.g. remove `#egg=camel-ai[all]`) will behave as expected.
7070

@@ -174,10 +174,10 @@ r"""Class for managing conversations of CAMEL Chat Agents.
174174
Example:
175175
```markdown
176176
Args:
177-
system_message (BaseMessage): The system message for initializing
177+
system_message (BaseMessage): The system message for initializing
178178
the agent's conversation context.
179-
model (BaseModelBackend, optional): The model backend to use for
180-
response generation. Defaults to :obj:`OpenAIModel` with
179+
model (BaseModelBackend, optional): The model backend to use for
180+
response generation. Defaults to :obj:`OpenAIModel` with
181181
`GPT_4O_MINI`. (default: :obj:`OpenAIModel` with `GPT_4O_MINI`)
182182
```
183183

@@ -220,12 +220,12 @@ Avoid using `print` for output. Use Python's `logging` module (`logger`) to ensu
220220

221221
Examples:
222222

223-
- Bad:
223+
- Bad:
224224
```python
225225
print("Process started")
226226
print(f"User input: {user_input}")
227227
```
228-
- Good:
228+
- Good:
229229
```python
230230
Args:
231231
logger.info("Process started")

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,4 +198,4 @@
198198
distributed under the License is distributed on an "AS IS" BASIS,
199199
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200200
See the License for the specific language governing permissions and
201-
limitations under the License.
201+
limitations under the License.

README.ja.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -632,4 +632,4 @@ CAMELのマルチエージェントフレームワークがインフラ自動化
632632
[package-download-url]: https://pypi.org/project/camel-ai
633633
[join-us]:https://eigent-ai.notion.site/eigent-ai-careers
634634
[join-us-image]:https://img.shields.io/badge/Join%20Us-yellow?style=plastic
635-
[image-join-us]: https://camel-ai.github.io/camel_asset/graphics/join_us.png
635+
[image-join-us]: https://camel-ai.github.io/camel_asset/graphics/join_us.png

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
<br>
5050

5151

52-
Join us ([*Discord*](https://discord.camel-ai.org/) or [*WeChat*](https://ghli.org/camel/wechat.png)) in pushing the boundaries of finding the scaling laws of agents.
52+
Join us ([*Discord*](https://discord.camel-ai.org/) or [*WeChat*](https://ghli.org/camel/wechat.png)) in pushing the boundaries of finding the scaling laws of agents.
5353

5454
🌟 Star CAMEL on GitHub and be instantly notified of new releases.
5555

@@ -382,7 +382,7 @@ We believe that studying these agents on a large scale offers valuable insights
382382

383383
>### Research with US
384384
>
385-
>We warmly invite you to use CAMEL for your impactful research.
385+
>We warmly invite you to use CAMEL for your impactful research.
386386
>
387387
> Rigorous research takes time and resources. We are a community-driven research collective with 100+ researchers exploring the frontier research of Multi-agent Systems. Join our ongoing projects or test new ideas with us, [reach out via email](mailto:[email protected]) for more information.
388388
>
@@ -538,7 +538,7 @@ We are actively involved in community events including:
538538
- 🎙️ **Community Meetings** — Weekly virtual syncs with the CAMEL team
539539
- 🏆 **Competitions** — Hackathons, Bounty Tasks and coding challenges hosted by CAMEL
540540
- 🤝 **Volunteer Activities** — Contributions, documentation drives, and mentorship
541-
- 🌍 **Ambassador Programs** — Represent CAMEL in your university or local tech groups
541+
- 🌍 **Ambassador Programs** — Represent CAMEL in your university or local tech groups
542542

543543
> Want to host or participate in a CAMEL event? Join our [Discord](https://discord.com/invite/CNcNpquyDc) or want to be part of [Ambassador Program](https://www.camel-ai.org/ambassador).
544544

0 commit comments

Comments
 (0)