Merge pull request #539 from nomic-ai/rguo123/readme_and_contributing_doc

Contributing Guidelines and README

.github/PR_TEMPLATE/pull_request_template.md

@@ -0,0 +1,19 @@
+## Describe your changes
+
+## Issue ticket number and link
+
+## Checklist before requesting a review
+- [ ] I have performed a self-review of my code.
+- [ ] If it is a core feature, I have added thorough tests.
+- [ ] I have added thorough documentation for my code.
+- [ ] I have tagged PR with relevant project identifiers.
+- [ ] If this PR addresses a bug, I have provided both a screenshot/video of the original bug and the working solution.
+
+## Demo
+<!-- Screenshots or video of new or updated code changes !-->
+
+### Steps to Reproduce
+<!-- Steps to reproduce demo !-->
+
+## Notes
+<!-- Any other relevant information to include about PR !-->

CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a build.
+2. Make sure Pull Request is tagged with appropriate project identifiers and has a clear description of contribution.
+3. Any new or updated code must have documentation and preferrably tests included with Pull Request.
+4. Significant feature or code changes should provide a short video or screenshot demo.
+4. Fill out relevant parts of Pull Request template. 
+4. Pull requests must have sign-off from one other developer. Reach out to a repository owner once your
+   code is ready to be merged into `main`.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at support@nomic.ai. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

README.md

@@ -1,5 +1,5 @@
 <h1 align="center">GPT4All</h1>
-<p align="center">Demo, data, and code to train open-source assistant-style large language model based on GPT-J and LLaMa</p>
+<p align="center">Open-source assistant-style large language models that run locally on CPU</p>
 
 <p align="center">
 <a href="https://gpt4all.io">GPT4All Website</a>
@@ -23,7 +23,7 @@
 </p>
 
 <p align="center">
-<a href="https://github.com/nomic-ai/pyllamacpp">:snake: Official Python Bindings</a>
+<a href="https://github.com/nomic-ai/gpt4all/tree/main/gpt4all-bindings/python/README.md">:snake: Official Python Bindings</a>
 </p>
 
 <p align="center">
@@ -57,6 +57,16 @@ GPT4All is made possible by our compute partner <a href="https://www.paperspace.
 Run on an M1 Mac (not sped up!)
 
 
+## Contributing
+GPT4All welcomes contribution, involvment, and discussion from the open source community!
+Please see CONTRIBUTING.md and follow the issue, bug report, and PR markdown templates.
+
+Check project discord, with project owners, or through existing issues/PRs to avoid duplicate work.
+Please make sure to tag all of the above with relevant project identifiers or your contribution could potentially get lost.
+Example tags: `backend`, `bindings`, `python-bindings`, `documentation`, etc.
+ 
+
+
 ### Chat Client
 Run any GPT4All model natively on your home desktop with the auto-updating desktop chat client. See website for exaustive list of models.
 
@@ -83,6 +93,18 @@ If you have older hardware that only supports avx and not avx2 you can use these
 
 Find the most up-to-date information on the [GPT4All Website](https://gpt4all.io/)
 
+### Python Bindings
+
+```bash
+pip install gpt4all
+```
+
+```python
+import gpt4all
+gptj = gpt4all.GPT4All("ggml-gpt4all-j-v1.3-groovy")
+messages = [{"role": "user", "content": "Name 3 colors"}]
+gptj.chat_completion(messages)
+```
 
 ## Training GPT4All-J