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.

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

Document function get_memory in autogpt.memory.vector #1296

Merged
merged 3 commits into from
Jul 7, 2023

Conversation

sagarishere
Copy link
Contributor

Document function get_memory in ./scripts/memory/init.py

Background

def get_memory was not documented. Now it is.

Documentation helps greatly some developers, when they can move the pointer over a function and read exactly what it does.

Changes

Just Documentation

PR Quality Checklist

  • My pull request is atomic and focuses on a single change.
  • I have thoroughly tested my changes with multiple different prompts.
  • I have considered potential risks and mitigations for my changes.
  • I have documented my changes clearly and comprehensively.
  • I have not snuck in any "extra" small tweaks changes

Document function get_memory in ./scripts/memory/init.py

Background
def get_memory was not documented. Now it is.

Documentation helps greatly some developers, when they can move the pointer over a function and read exactly what it does.

Changes
Documentation
@sjnt1
Copy link

sjnt1 commented Apr 14, 2023

Sorry for the noob question but is my redis stack server / cotainer working properly when it shows this all the time :

2023-04-14 19:42:21 42:C 14 Apr 2023 17:42:21.019 * DB saved on disk
2023-04-14 19:42:21 42:C 14 Apr 2023 17:42:21.019 * RDB: 0 MB of memory used by copy-on-write

Seems like its not storing any data?

@sagarishere
Copy link
Contributor Author

Hi. Replying to the Redis question. It works. Nothing to worry about. This is overhead memory indicator. This is an ideal number

@github-actions github-actions bot added the conflicts Automatically applied to PRs with merge conflicts label Apr 17, 2023
@github-actions
Copy link
Contributor

This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.

3 similar comments
@github-actions
Copy link
Contributor

This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.

@github-actions
Copy link
Contributor

This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.

@github-actions
Copy link
Contributor

This pull request has conflicts with the base branch, please resolve those so we can evaluate the pull request.

@p-i-
Copy link
Contributor

p-i- commented May 5, 2023

This is a mass message from the AutoGPT core team.
Our apologies for the ongoing delay in processing PRs.
This is because we are re-architecting the AutoGPT core!

For more details (and for infor on joining our Discord), please refer to:
https://github.com/Significant-Gravitas/Auto-GPT/wiki/Architecting

@Boostrix Boostrix requested a review from dschonholtz May 16, 2023 15:15
dschonholtz
dschonholtz previously approved these changes May 18, 2023
Copy link
Contributor

@dschonholtz dschonholtz left a comment

Choose a reason for hiding this comment

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

This is a small, useful, atomic change that adds value.
Approved.
If it is not passing lint, make sure it does before merging.
I am not worried about the nit on spacing. If you can make that work while it continues to pass linting stuff that's great. If you can't get it to play nice with the linter with the suggested changes, just merge it where it passes the lint check.

Thanks for the contribution!

@dschonholtz
Copy link
Contributor

Also, conflicts etc

@github-actions github-actions bot removed the conflicts Automatically applied to PRs with merge conflicts label Jul 7, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jul 7, 2023

Conflicts have been resolved! 🎉 A maintainer will review the pull request shortly.

@github-actions github-actions bot added the size/m label Jul 7, 2023
@netlify
Copy link

netlify bot commented Jul 7, 2023

Deploy Preview for auto-gpt-docs canceled.

Name Link
🔨 Latest commit d5ef80a
🔍 Latest deploy log https://app.netlify.com/sites/auto-gpt-docs/deploys/64a7a4102e40ea000872d580

@Pwuts Pwuts changed the title Document function get_memory in ./scripts/memory/init.py Document function get_memory in autogpt.memory.vector Jul 7, 2023
@Pwuts Pwuts added this to the v0.4.5 Release milestone Jul 7, 2023
@Pwuts Pwuts self-assigned this Jul 7, 2023
@Pwuts Pwuts added the code quality ⬆️ PRs that improve code quality label Jul 7, 2023
@Pwuts Pwuts merged commit 9a2a9f7 into Significant-Gravitas:master Jul 7, 2023
@lc0rp lc0rp modified the milestones: v0.4.5 Release, v0.4.4 Release Jul 8, 2023
dayofthedave pushed a commit to dayofthedave/Auto-GPT that referenced this pull request Jul 17, 2023
…ignificant-Gravitas#1296)

* Document function get_memory in ./scripts/memory/init.py

* Update get_memory docstring to current format

---------

Co-authored-by: Reinier van der Leer <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality ⬆️ PRs that improve code quality size/m
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

7 participants