diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..adf26513 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "WareHouse/Gomoku_GitMode_20231025184031"] + path = WareHouse/Gomoku_GitMode_20231025184031 + url = ./WareHouse/Gomoku_GitMode_20231025184031 diff --git a/README.md b/README.md index c525bf02..5aeb6188 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ ## 🎉 News -* **September 25th, 2023: The **Git** feature is now available**, enabling the programmer to utilize GitHub for version control. To enable this feature, simply set ``"git_management"`` to ``"True"`` in ``ChatChainConfig.json``. +* **September 25th, 2023: The **Git** feature is now available**, enabling the programmer to utilize GitHub for version control. To enable this feature, simply set ``"git_management"`` to ``"True"`` in ``ChatChainConfig.json``. See [guide](wiki.md#git-mode) and [example](WareHouse/Gomoku_GitMode_20231025184031).

diff --git a/WareHouse/Gomoku_GitMode_20231025184031 b/WareHouse/Gomoku_GitMode_20231025184031 new file mode 160000 index 00000000..e0396448 --- /dev/null +++ b/WareHouse/Gomoku_GitMode_20231025184031 @@ -0,0 +1 @@ +Subproject commit e0396448114be2e320564cdfbe6bcf4082dd4e42 diff --git a/camel/model_backend.py b/camel/model_backend.py index 7f8c1926..d54eea44 100644 --- a/camel/model_backend.py +++ b/camel/model_backend.py @@ -16,7 +16,6 @@ from typing import Any, Dict import openai import tiktoken -from retry import retry from camel.typing import ModelType from chatdev.statistics import prompt_cost @@ -49,7 +48,6 @@ class OpenAIModel(ModelBackend): self.model_type = model_type self.model_config_dict = model_config_dict - # @retry(tries=-1, delay=0, max_delay=None, backoff=1, jitter=0) def run(self, *args, **kwargs) -> Dict[str, Any]: string = "\n".join([message["content"] for message in kwargs["messages"]]) encoding = tiktoken.encoding_for_model(self.model_type.value) diff --git a/misc/git_summary_onlinelog.png b/misc/git_summary_onlinelog.png new file mode 100644 index 00000000..7b5b9309 Binary files /dev/null and b/misc/git_summary_onlinelog.png differ diff --git a/misc/git_summary_terminal.png b/misc/git_summary_terminal.png new file mode 100644 index 00000000..51dbf9ab Binary files /dev/null and b/misc/git_summary_terminal.png differ diff --git a/misc/the_log_left.png b/misc/the_log_left.png new file mode 100644 index 00000000..f2dd8e8f Binary files /dev/null and b/misc/the_log_left.png differ diff --git a/wiki.md b/wiki.md index 15c3b19a..5d92dba7 100644 --- a/wiki.md +++ b/wiki.md @@ -269,7 +269,7 @@ then go to [Local Demo Website](http://127.0.0.1:8000/) to see an online visuali ### Human-Agent Interaction ![demo](misc/ChatChain_Visualization_Human.png) - Compared to Default, in ***Human-Agent-Interaction*** mode you can play as reviewer and asks programmer agent to modify the code based on your comments. -- It adds a Phase called HumanAgentInteraction after the CodeReview Phase. +- It adds a Phase called HumanAgentInteraction after the dCodeReview Phase. - You can use ***Human-Agent-Interaction*** setting using ``python3 run.py --config "Human"``. - When chatdev executes to this Phase, on the command interface you will see a hint that ask for input. - You can run your software in the ``WareHouse/`` and see if it satisfies your need. Then you can type anything you want (bug fix or new feature) in the command interface, then press Enter: @@ -282,5 +282,39 @@ then go to [Local Demo Website](http://127.0.0.1:8000/) to see an online visuali - Below shows all three versions. -          +### Git Mode +- Simply set ``"git_management"`` to ``"True"`` in ``ChatChainConfig.json`` enables the Git Mode, in which ChatDev will make the generated software folder a git repository and automatically make all commits. +- Every change made on the code of generated software will create a commit, including: + - The initial commit, created after the ``Coding`` phase completed, with a commit message ``Finish Coding``. + - Complete ``ArtIntegration`` phase, with a commit message ``Finish Art Integration``. + - Complete ``CodeComplete`` phase, with a commit message ``Code Complete #1/2/3 Finished``(if the CodeComplete is executed in three loops). + - Complete ``CodeReviewModification`` phase, with a commit message ``Review #1/2/3 Finished``(if the CodeReviewModification is executed in three loops). + - Complete ``CodeReviewHuman`` phase, with a commit message ``Human Review #1/2/3 Finished``(if the CodeReviewHuman is executed in three loops). + - Complete ``TestModification`` phase, with a commit message ``Test #1/2/3 Finished``(if the TestModification is executed in three loops). + - Complete ``ArtIntegration`` phase, with a commit message ``Finish Art Integration``. + - All phases completed, with a commit message ``Final Version``. +- On the terminal and online log UI you can see the git summary at the end of process. + -      + - You can also search ``git Information`` in the log file to see when did commit happen. +- ⚠️ There are a few things worth noting about Git Mode: + - ChatDev is a git project, and we need to create another git project in the generated software folder, so we use ``git submodule`` to make this "git over git" function. A ``.gitmodule`` file will be created. + - under the software folder, you can add/commit/push/checkout the software project just like a normal git project, and your commits would not modify the ChatDev git history. + - under the ChatDev folder, the new software has been added to the ChatDev as a whole folder. + - The generated log file would not be added into the software git project, since the log is closed and moved to the software folder after the final commit. We have to do this because the log should record all the git commits, including the final one. So the git operations must be done before the log finalized. You will always see a log file to be added and committed in the software folder, like: + - ![img.png](misc/the_log_left.png) + - When you perform ``git add .`` under the ChatDev project, There will be information like (taking Gomoku for example): + ```commandline + Changes to be committed: + (use "git restore --staged ..." to unstage) + new file: .gitmodules + new file: WareHouse/Gomoku_GitMode_20231025184031 - + Changes not staged for commit: + (use "git add ..." to update what will be committed) + (use "git restore ..." to discard changes in working directory) + (commit or discard the untracked or modified content in submodules) + modified: WareHouse/Gomoku_GitMode_20231025184031 (untracked content) + ``` + If you add and commit the software log file under the software folder, there will be no ``Changes not staged for commit:`` + - Some phase executions may not change the code, and thereby there is no commit. For example, the software is tested without problems and there is no modification, so the test phase would leave no commit. + \ No newline at end of file