Improve `TextPrompt` and add docs #127

lightaime · 2023-05-29T00:20:03Z

No description provided.

github-actions · 2023-05-29T00:21:32Z

.github/workflows/documentation.yaml

@@ -10,7 +10,7 @@ jobs:
      - uses: actions/setup-python@v3


GPT summary of 0ce035 - 613baf:

Replaced pip install command with updated version, adding recommonmark package.

github-actions · 2023-05-29T00:21:38Z

.github/workflows/gpt-commit-summarizer.yml

@@ -0,0 +1,17 @@
+name: GPT Commits summarizer


GPT summary of None - 9e155e:

This action will write a comment about every commit in a pull request

Generate a summary for every file that was modified and add it to the review page

Compile a PR summary from all commit summaries and file diff summaries

Delete outdated code review comments

github-actions · 2023-05-29T00:21:46Z

camel/prompts/base.py

@@ -1,12 +1,78 @@
-from typing import Any, Dict, Set
+import inspect


GPT summary of 255b6f - 49a377:

Imported inspect module and added T type variable

Added return_text_prompt decorator and wrap_text_prompt_functions decorator

Updated TextPrompt class to extend str class and added key_words property

Updated format method to return a TextPrompt instance with the formatted string

github-actions · 2023-05-29T00:21:52Z

docs/README.md

@@ -6,3 +6,38 @@ sphinx-apidoc -o docs camel/
 ```


GPT summary of 2cf7c2 - e55af4:

Instructions added for installing CAMEL from source

Instructions added for installing Sphinx, Sphinx theme and recommonmark

Instructions added for building the documentation with make

Instructions added for launching the HTML documentation from the terminal using a local HTTP server

github-actions · 2023-05-29T00:21:55Z

docs/camel.rst

@@ -1,4 +1,4 @@
-camel package
+Camel Package


GPT summary of 72818d - e1c507:

Changed the title of the file from "camel package" to "Camel Package"

Added a section for "Subpackages"

github-actions · 2023-05-29T00:21:58Z

docs/conf.py

@@ -11,17 +11,25 @@



GPT summary of dac50c - 0efe7b:

Changed project, copyright and author names

Added source_suffix

Added recommonmark extension

Changed html_theme

Removed html_static_path

github-actions · 2023-05-29T00:22:07Z

docs/get_started/prompts.md

@@ -0,0 +1,112 @@
+# Write Your Prompts with the `TextPrompt` Class


GPT summary of None - 0a1fa7:

The TextPrompt class is a subclass of the built-in str class and provides additional features for working with text prompts.

It provides a property called key_words, which returns a set of strings representing the key words in the prompt.

It also provides a format method to allow for partial formatting values in the format string.

It can be manipulated with various string manipulation operations, such as concatenation, joining, and applying string methods.

github-actions · 2023-05-29T00:22:11Z

docs/index.rst

@@ -1,14 +1,26 @@
-.. Camel documentation master file, created by
+.. CAMEL documentation master file, created by


GPT summary of 6c0a5b - 036c93:

Changed the title from "Camel" to "CAMEL"

Added a description of CAMEL

Added a link to join the slack channel

Added a section for getting started

Modified the contents section to "Modules"

github-actions · 2023-05-29T00:22:21Z

GPT summary of 1824dd0:

Error: couldn't generate summary

github-actions · 2023-05-29T00:22:25Z

GPT summary of 22ce3d6:

Added a Github Action for GPT commit summarizer gpt-commit-summarizer.yml

github-actions · 2023-05-29T00:22:34Z

GPT summary of e11720f:

Not generating summary for merge commits

PR summary so far:

Added a Github Action for GPT commit summarizer
Updated the documentation with instructions for installing CAMEL from source, and building the documentation with make
Updated TextPrompt class to extend str class and added key_words property
Added return_text_prompt and wrap_text_prompt_functions decorators
Added a TextPromptDict class for storing TextPrompts

… improve_text_prompt

github-actions · 2023-05-29T00:26:50Z

test/prompts/test_base.py

@@ -1,11 +1,69 @@
-from camel.prompts import TextPrompt, TextPromptDict
+from camel.prompts.base import (


GPT summary of 58172b - b5bfbf:

Added functions return_text_prompt and wrap_text_prompt_functions to the TextPrompt base class.

Added tests for return_text_prompt and wrap_text_prompt_functions.

Added tests for TextPrompt's key_words and format methods.

Added tests for TextPrompt's manipulate and upper methods.

github-actions · 2023-05-29T00:26:57Z

GPT summary of 9e00c2f:

Changed the capitalization of the key word in the TextPrompt from name to NAME test_base.py

github-actions · 2023-05-29T00:27:08Z

GPT summary of 3002141:

Not generating summary for merge commits

PR summary so far:

Added Github Action for GPT commit summarizer
Updated the TextPrompt class to extend str class and added key_words property
Updated format method to return a TextPrompt instance with the formatted string
Added instructions for installing CAMEL from source, Sphinx, Sphinx theme and recommonmark
Added instructions for building the documentation with make and launching the HTML documentation from the terminal using a local HTTP server
Added functions return_text_prompt and wrap_text_prompt_functions to the TextPrompt base class and tests for them
Added tests for TextPrompt's key_words and format methods, as well as manipulate and upper methods

Obs01ete

Overall seems good

Obs01ete · 2023-05-29T10:30:12Z

docs/README.md

+2. Install Sphinx, Sphinx theme and `recommonmark` (Sphinx extension that enables Markdown support) by running the following command in your terminal or command prompt:
+```bash
+pip install sphinx
+pip install sphinx-rtd-theme


We have already moved to the book theme. Replace with:

pip install sphinx_book_theme

Thanks for the review!

Obs01ete · 2023-05-29T10:33:50Z

.github/workflows/gpt-commit-summarizer.yml

+    permissions: write-all  # Some repositories need this line
+
+    steps:
+      - uses: KanHarI/gpt-commit-summarizer@master


I suggest to remove this action. Its span is irritating. I can see the code myself, I do not need trivial comments on it.

lightaime added 2 commits May 29, 2023 03:11

Improve TextPrompt and add docs

1824dd0

Add gpt commit summarizer

22ce3d6

lightaime added documentation Improvements or additions to documentation Prompt Related to camel prompts labels May 29, 2023

lightaime self-assigned this May 29, 2023

Merge branch 'master' into improve_text_prompt

e11720f

github-actions bot reviewed May 29, 2023

View reviewed changes

lightaime added 2 commits May 29, 2023 03:25

update

9e00c2f

Merge branch 'improve_text_prompt' of github.com:lightaime/camel into…

3002141

… improve_text_prompt

github-actions bot reviewed May 29, 2023

View reviewed changes

lightaime requested review from Benjamin-eecs, Obs01ete, HaniItani and hammoudhasan May 29, 2023 00:41

lightaime changed the title ~~Improve TextPrompt and add docs~~ Improve TextPrompt and add docs May 29, 2023

Obs01ete approved these changes May 29, 2023

View reviewed changes

Remove gpt commit summarizer action and fix docs readme

6c77534

lightaime merged commit 347dd66 into master May 29, 2023

lightaime deleted the improve_text_prompt branch May 29, 2023 14:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve `TextPrompt` and add docs #127

Improve `TextPrompt` and add docs #127

lightaime commented May 29, 2023

github-actions bot May 29, 2023

github-actions bot May 29, 2023

github-actions bot May 29, 2023

github-actions bot May 29, 2023

github-actions bot May 29, 2023

github-actions bot May 29, 2023

github-actions bot May 29, 2023

github-actions bot May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot May 29, 2023 •

edited by lightaime

Loading

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023 •

edited by lightaime

Loading

Obs01ete left a comment

Obs01ete May 29, 2023

lightaime May 29, 2023

lightaime May 29, 2023

Obs01ete May 29, 2023

lightaime May 29, 2023

		@@ -1,12 +1,78 @@
		from typing import Any, Dict, Set
		import inspect

		@@ -0,0 +1,112 @@
		# Write Your Prompts with the `TextPrompt` Class

		@@ -1,14 +1,26 @@
		.. Camel documentation master file, created by
		.. CAMEL documentation master file, created by

		@@ -1,11 +1,69 @@
		from camel.prompts import TextPrompt, TextPromptDict
		from camel.prompts.base import (

Improve TextPrompt and add docs #127

Improve TextPrompt and add docs #127

Conversation

lightaime commented May 29, 2023

github-actions bot May 29, 2023

Choose a reason for hiding this comment

github-actions bot May 29, 2023

Choose a reason for hiding this comment

github-actions bot May 29, 2023

Choose a reason for hiding this comment

github-actions bot May 29, 2023

Choose a reason for hiding this comment

github-actions bot May 29, 2023

Choose a reason for hiding this comment

github-actions bot May 29, 2023

Choose a reason for hiding this comment

github-actions bot May 29, 2023

Choose a reason for hiding this comment

github-actions bot May 29, 2023

Choose a reason for hiding this comment

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023

github-actions bot May 29, 2023 • edited by lightaime Loading

Choose a reason for hiding this comment

github-actions bot commented May 29, 2023

github-actions bot commented May 29, 2023 • edited by lightaime Loading

Obs01ete left a comment

Choose a reason for hiding this comment

Obs01ete May 29, 2023

Choose a reason for hiding this comment

lightaime May 29, 2023

Choose a reason for hiding this comment

lightaime May 29, 2023

Choose a reason for hiding this comment

Obs01ete May 29, 2023

Choose a reason for hiding this comment

lightaime May 29, 2023

Choose a reason for hiding this comment

Improve `TextPrompt` and add docs #127

Improve `TextPrompt` and add docs #127

github-actions bot May 29, 2023 •

edited by lightaime

Loading

github-actions bot commented May 29, 2023 •

edited by lightaime

Loading