github/langchain
1
0
Fork 0
mirror of https://github.com/hwchase17/langchain.git synced 2025-09-08 14:31:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor prompts into module, add example generation utils (#64)

Browse Source
This commit is contained in:
Samantha Whitmore
2022-11-06 15:40:33 -08:00
committed by GitHub
parent dce26dfcec
commit a5b61d59e1
20 changed files with 414 additions and 254 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -107,7 +107,7 @@ but full API docs can be found [here](https://langchain.readthedocs.io/en/latest
## 🤖 Developer Guide
To begin developing on this project, first clone to the repo locally.
To install requirements, run `pip install -r requirments.txt`.
To install requirements, run `pip install -r requirements.txt`.
This will install all requirements for running the package, examples, linting, formatting, and tests.
Formatting for this project is a combination of [Black](https://black.readthedocs.io/en/stable/) and [isort](https://pycqa.github.io/isort/).
@@ -125,6 +125,8 @@ Integration tests cover logic that requires making calls to outside APIs (often
To run integration tests, run `make integration_tests`.
If you add support for a new external API, please add a new integration test.
If you are adding a Jupyter notebook example, you can run `pip install -e .` to build the langchain package from your local changes, so your new logic can be imported into the notebook.
Docs are largely autogenerated by [sphinx](https://www.sphinx-doc.org/en/master/) from the code.
For that reason, we ask that you add good documentation to all classes and methods.
Similar to linting, we recognize documentation can be annoying - if you do not want to do it, please contact a project maintainer and they can help you with it. We do not want this to be a blocker for good code getting contributed.