feat: add platform info to the system prompt #171

0xbrayo · 2024-10-08T13:16:45Z

Important

Adds system information to about_user prompt and introduces functions for system info retrieval in gptme/prompts.py.

Behavior:
- Adds system information to about_user prompt in prompt_user() in gptme/prompts.py.
- Introduces prompt_systeminfo() to generate system information prompt.
- Implements get_system_distro() to retrieve Linux distribution name.
Dependencies:
- Adds distro package to pyproject.toml for Linux distribution information.

^{This description was created by}^{for 9b4832f. It will automatically update as commits are pushed.}

ellipsis-dev

❌ Changes requested. Reviewed everything up to e610554 in 24 seconds

More details

Looked at 56 lines of code in 2 files
Skipped 1 files when reviewing.
Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_r7F2rP7I7n2tl2kZ

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev · 2024-10-08T13:17:17Z

gptme/prompts.py

+        version = os.uname().version
+    elif os.name == "nt":
+        distro = "Windows"
+        version = os.uname().version


os.uname() is not available on Windows. Consider using platform.version() or platform.release() for Windows version information.

0xbrayo · 2024-10-08T13:21:20Z

@ellipsis-dev do another review

ellipsis-dev

❌ Changes requested. Reviewed everything up to 2b1f6d6 in 28 seconds

More details

Looked at 60 lines of code in 2 files
Skipped 1 files when reviewing.
Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_UV74QwS9w152cgUL

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev · 2024-10-08T13:22:03Z

gptme/prompts.py

@@ -208,6 +210,21 @@ def prompt_tools(examples: bool = True) -> Generator[Message, None, None]:
    prompt += "\n\n*End of Tools List.*"
    yield Message("system", prompt.strip() + "\n\n")

+def get_system_info() -> str:


Consider adding exception handling in get_system_info() to manage potential errors when retrieving system information, such as when the distro package fails.

ErikBjare · 2024-10-08T13:26:03Z

pyproject.toml

@@ -28,6 +28,7 @@ tomlkit = "*"
 typing-extensions = "*"
 platformdirs = "^4.3"
 lxml = "*"
+distro = "*"


I don't think such simple checks justifies a dependency.

Just use platform, you can call out to lsb_release -d (if it exists on system) if you want specific distro.

@ErikBjare My system does not have lsb_release -d installed on default expecting more devices probably don't have installed by default. A workaround suggested is to read the contents of /etc/os-release

ErikBjare · 2024-10-08T13:30:52Z

gptme/prompts.py

@@ -143,7 +145,7 @@ def prompt_user() -> Generator[Message, None, None]:
    """
    config_prompt = get_config().prompt
    about_user = config_prompt.get(
-        "about_user", "You are interacting with a human programmer."
+        "about_user", f"You are interacting with a human programmer. I am running a {get_system_info()} system."


I don't think we want to add it to the user prompt like this.

I'd like the config to be platform-portable (I copy mine between machines), and this wouldn't work for users with an old config.

prompt_user is also not included in non-interactive mode, but it's useful in non-interactive mode too.

Maybe add a prompt_systeminfo?

0xbrayo · 2024-10-08T15:03:44Z

@ellipsis-dev review

ellipsis-dev

❌ Changes requested. Reviewed everything up to 8fcd414 in 39 seconds

More details

Looked at 62 lines of code in 1 files
Skipped 0 files when reviewing.
Skipped posting 0 drafted comments based on config settings.

Workflow ID: wflow_bdClyRn5lcCwgDO3

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev · 2024-10-08T15:04:32Z

gptme/prompts.py

@@ -208,8 +211,39 @@ def prompt_tools(examples: bool = True) -> Generator[Message, None, None]:
    prompt += "\n\n*End of Tools List.*"
    yield Message("system", prompt.strip() + "\n\n")

+def prompt_systeminfo() -> Generator[Message, None, None]:
+    """Generate the system information prompt."""
+    if os.name == "posix":


The check for os.name == "darwin" is incorrect. os.name returns 'posix' for both Linux and macOS. Use platform.system() to differentiate between Linux and macOS.

ellipsis-dev · 2024-10-08T15:04:32Z

gptme/prompts.py

+
+    yield Message( "system", prompt,)
+
+def get_system_distro() -> str:


Consider using the distro package to get the system distribution name for better accuracy and maintainability.

@ellipsis-dev compile this regex

@brayo-pip, I have addressed your comments in pull request #229

You can configure Ellipsis to address comments with a direct commit or a side PR, see docs.

0xbrayo · 2024-10-08T15:13:40Z

@ellipsis-dev review

ellipsis-dev

❌ Changes requested. Reviewed everything up to 9b4832f in 22 seconds

More details

Looked at 62 lines of code in 1 files
Skipped 0 files when reviewing.
Skipped posting 1 drafted comments based on config settings.

1. gptme/prompts.py:231

Draft comment:
Ensure consistent formatting for Message instantiation. Suggestion:

    yield Message("system", prompt)

Reason this comment was not posted:
Confidence changes required: 50%
The prompt_systeminfo function has inconsistent formatting for the Message instantiation.

Workflow ID: wflow_lo0xDiy22ebBOste

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

ellipsis-dev · 2024-10-08T15:14:12Z

gptme/prompts.py

+
+def get_system_distro() -> str:
+    """Get the system distribution name."""
+    regex = r"^NAME=\"([^\"]+)\""


The regex pattern in get_system_distro is too specific. Consider using r'^NAME=("?)([^\n]+)\1$' to match entries with or without quotes.

ErikBjare · 2024-10-10T09:12:55Z

I just noticed/remembered I added this little line in the shell tool instructions to make it aware of macOS systems:

gptme/gptme/tools/shell.py

Line 53 in f258602

{'The platform is macOS.' if is_macos else ''}

…to the system prompt);

0xbrayo · 2024-10-28T08:21:36Z

@ErikBjare Review this whenever 👍

0xbrayo · 2024-10-28T08:43:03Z

Closes #166

ErikBjare

Looks good!

Just a minor nit on prompt formatting. Also recommend you set up pre-commit so that the code gets formatted correctly (I should add a formatting check to CI).

gptme/prompts.py

Co-authored-by: Erik Bjäreholt <[email protected]>

ErikBjare · 2024-10-29T13:36:29Z

Nice, thanks!

ErikBjare · 2024-11-01T11:12:16Z

Got this weird output when testing in #225: Ubuntu 6.6.57-1-lts

So we accidentally got the kernel version and not the distro version.

ErikBjare · 2024-11-01T11:14:36Z

gptme/prompts.py

+def get_system_distro() -> str:
+    """Get the system distribution name."""
+    regex = re.compile(r"^NAME=\"?([^\"]+)\"?")
+    if os.path.exists("/etc/os-release"):
+        with open("/etc/os-release") as f:
+            for line in f:
+                matches = re.search(regex, line)
+                if matches:
+                    return matches.string[matches.start(1) : matches.end(1)]
+    return "Linux"


We should get the distro version here (BUILD_ID=rolling on Arch, VERSION_ID="22.04" on Ubuntu) instead of using platform.uname().release

Will check into this. Also getting the same on my laptop, capturing the kernel version instead of the distro version.

ellipsis-dev bot reviewed Oct 8, 2024

View reviewed changes

0xbrayo force-pushed the master branch from e610554 to 2b1f6d6 Compare October 8, 2024 13:20

ellipsis-dev bot reviewed Oct 8, 2024

View reviewed changes

ErikBjare reviewed Oct 8, 2024

View reviewed changes

0xbrayo force-pushed the master branch 2 times, most recently from 397c091 to 8fcd414 Compare October 8, 2024 15:03

ellipsis-dev bot reviewed Oct 8, 2024

View reviewed changes

0xbrayo force-pushed the master branch from 8fcd414 to 9b4832f Compare October 8, 2024 15:12

ellipsis-dev bot reviewed Oct 8, 2024

View reviewed changes

0xbrayo force-pushed the master branch 3 times, most recently from df07566 to 60f5360 Compare October 8, 2024 20:23

ErikBjare mentioned this pull request Oct 10, 2024

feat: whitelist some commands #190

Merged

0xbrayo force-pushed the master branch from d932eb7 to c71ad2e Compare October 20, 2024 20:18

0xbrayo added 4 commits October 21, 2024 23:11

feat: create a system info prompt

d760d2b

fix: update the prompt

cf240e1

chore: remove trailing comma in prompt

5559c95

feat: remove redundant platform specification

428f4a6

0xbrayo force-pushed the master branch 2 times, most recently from 056a17b to 428f4a6 Compare October 22, 2024 21:23

0xbrayo changed the title ~~feat: add system info to the about_user prompt~~ feat: add platform info to the system prompt Oct 23, 2024

ellipsis-dev bot added a commit that referenced this pull request Oct 26, 2024

address comments left by @brayo-pip on #171 (feat: add platform info …

c3107c8

…to the system prompt);

ellipsis-dev bot mentioned this pull request Oct 26, 2024

[Ellipsis] feat: add system information prompts and minor text adjustments #229

Closed

ErikBjare reviewed Oct 28, 2024

View reviewed changes

gptme/prompts.py Outdated Show resolved Hide resolved

gptme/prompts.py Outdated Show resolved Hide resolved

0xbrayo and others added 2 commits October 28, 2024 15:00

Update gptme/prompts.py

31ec9e7

Co-authored-by: Erik Bjäreholt <[email protected]>

Update gptme/prompts.py

fb1bca9

Co-authored-by: Erik Bjäreholt <[email protected]>

0xbrayo force-pushed the master branch from a5c9d37 to fb1bca9 Compare October 28, 2024 13:34

feat: compile regex

d49b590

ErikBjare merged commit 0288d33 into ErikBjare:master Oct 29, 2024
4 of 7 checks passed

ErikBjare reviewed Nov 1, 2024

View reviewed changes

ErikBjare mentioned this pull request Nov 1, 2024

Fix incorrect distro version in system info prompt on Linux #238

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add platform info to the system prompt #171

feat: add platform info to the system prompt #171

0xbrayo commented Oct 8, 2024 •

edited by ellipsis-dev bot

Loading

ellipsis-dev bot left a comment

ellipsis-dev bot Oct 8, 2024

0xbrayo commented Oct 8, 2024

ellipsis-dev bot left a comment

ellipsis-dev bot Oct 8, 2024

ErikBjare Oct 8, 2024 •

edited

Loading

0xbrayo Oct 8, 2024

0xbrayo Oct 8, 2024

ErikBjare Oct 8, 2024 •

edited

Loading

0xbrayo commented Oct 8, 2024

ellipsis-dev bot left a comment

ellipsis-dev bot Oct 8, 2024

ellipsis-dev bot Oct 8, 2024

0xbrayo Oct 26, 2024

ellipsis-dev bot Oct 26, 2024

0xbrayo commented Oct 8, 2024

ellipsis-dev bot left a comment

ellipsis-dev bot Oct 8, 2024

ErikBjare commented Oct 10, 2024 •

edited

Loading

0xbrayo commented Oct 28, 2024

0xbrayo commented Oct 28, 2024

ErikBjare left a comment

ErikBjare commented Oct 29, 2024

ErikBjare commented Nov 1, 2024

ErikBjare Nov 1, 2024 •

edited

Loading

0xbrayo Nov 1, 2024


		yield Message( "system", prompt,)

		def get_system_distro() -> str:

feat: add platform info to the system prompt #171

feat: add platform info to the system prompt #171

Conversation

0xbrayo commented Oct 8, 2024 • edited by ellipsis-dev bot Loading

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot Oct 8, 2024

Choose a reason for hiding this comment

0xbrayo commented Oct 8, 2024

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot Oct 8, 2024

Choose a reason for hiding this comment

ErikBjare Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

0xbrayo Oct 8, 2024

Choose a reason for hiding this comment

0xbrayo Oct 8, 2024

Choose a reason for hiding this comment

ErikBjare Oct 8, 2024 • edited Loading

Choose a reason for hiding this comment

0xbrayo commented Oct 8, 2024

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot Oct 8, 2024

Choose a reason for hiding this comment

ellipsis-dev bot Oct 8, 2024

Choose a reason for hiding this comment

0xbrayo Oct 26, 2024

Choose a reason for hiding this comment

ellipsis-dev bot Oct 26, 2024

Choose a reason for hiding this comment

0xbrayo commented Oct 8, 2024

ellipsis-dev bot left a comment

Choose a reason for hiding this comment

ellipsis-dev bot Oct 8, 2024

Choose a reason for hiding this comment

ErikBjare commented Oct 10, 2024 • edited Loading

0xbrayo commented Oct 28, 2024

0xbrayo commented Oct 28, 2024

ErikBjare left a comment

Choose a reason for hiding this comment

ErikBjare commented Oct 29, 2024

ErikBjare commented Nov 1, 2024

ErikBjare Nov 1, 2024 • edited Loading

Choose a reason for hiding this comment

0xbrayo Nov 1, 2024

Choose a reason for hiding this comment

0xbrayo commented Oct 8, 2024 •

edited by ellipsis-dev bot

Loading

ErikBjare Oct 8, 2024 •

edited

Loading

ErikBjare Oct 8, 2024 •

edited

Loading

ErikBjare commented Oct 10, 2024 •

edited

Loading

ErikBjare Nov 1, 2024 •

edited

Loading