-
Notifications
You must be signed in to change notification settings - Fork 16.3k
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
Add in-code documentation for LangChain Runnables #18803
Labels
🤖:docs
Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
good first issue
Good for newcomers
help wanted
Good issue for contributors
Ɑ: Runnables
Related to Runnables
Comments
May I take this issue? |
Yes! Anyone can sign up. Claim any of the runnables and post it here , so other folks can claim other runnables |
I would like to work upon RunnablePick |
I'll take on documenting |
eyurtsev
pushed a commit
that referenced
this issue
Mar 9, 2024
**Description:** Improves the docstring for `RunnableAssign` by providing a concise description and a self-contained code example. **Issue:** #18803
Hello, I would like to work upon |
This was referenced Mar 16, 2024
baskaryan
pushed a commit
that referenced
this issue
Mar 17, 2024
- [x] **Docs for `RouterRunnable`**: core: Add docs for `RouterRunnable` - [x] **Add docs for `RouterRunnable`**: - **Description:** Add docs for `RouterRunnable`, which was previously missing documentation - **Issue:** #18803 - **Dependencies:** N/A - **Twitter handle:** None
hwchase17
pushed a commit
that referenced
this issue
Mar 19, 2024
- **Description:** Improves the docstring for `class Context` by providing an overview and an example. - **Issue:** #18803
eyurtsev
pushed a commit
that referenced
this issue
Mar 20, 2024
**Description:** : Updated the docstring for RunnablePick. Added Overview and an Example for RunnablePick class. **Issue:** : #18803
gkorland
pushed a commit
to FalkorDB/langchain
that referenced
this issue
Mar 30, 2024
**Description:** Improves the docstring for `RunnableAssign` by providing a concise description and a self-contained code example. **Issue:** langchain-ai#18803
gkorland
pushed a commit
to FalkorDB/langchain
that referenced
this issue
Mar 30, 2024
- [x] **Docs for `RouterRunnable`**: core: Add docs for `RouterRunnable` - [x] **Add docs for `RouterRunnable`**: - **Description:** Add docs for `RouterRunnable`, which was previously missing documentation - **Issue:** langchain-ai#18803 - **Dependencies:** N/A - **Twitter handle:** None
gkorland
pushed a commit
to FalkorDB/langchain
that referenced
this issue
Mar 30, 2024
- **Description:** Improves the docstring for `class Context` by providing an overview and an example. - **Issue:** langchain-ai#18803
gkorland
pushed a commit
to FalkorDB/langchain
that referenced
this issue
Mar 30, 2024
**Description:** : Updated the docstring for RunnablePick. Added Overview and an Example for RunnablePick class. **Issue:** : langchain-ai#18803
chrispy-snps
pushed a commit
to chrispy-snps/langchain
that referenced
this issue
Mar 30, 2024
- **Description:** Improves the docstring for `class Context` by providing an overview and an example. - **Issue:** langchain-ai#18803
chrispy-snps
pushed a commit
to chrispy-snps/langchain
that referenced
this issue
Mar 30, 2024
**Description:** : Updated the docstring for RunnablePick. Added Overview and an Example for RunnablePick class. **Issue:** : langchain-ai#18803
1 task
ccurme
added a commit
that referenced
this issue
Apr 1, 2024
- [x] **docs**: core: Add docs for `RunnableConfigurableFields` - **Description:** Added incode docs for `RunnableConfigurableFields` with example - **Issue:** #18803 - **Dependencies:** NA - **Twitter handle:** NA --------- Co-authored-by: Chester Curme <[email protected]>
hinthornw
pushed a commit
that referenced
this issue
Apr 26, 2024
**Description:** Improves the docstring for `RunnableAssign` by providing a concise description and a self-contained code example. **Issue:** #18803
hinthornw
pushed a commit
that referenced
this issue
Apr 26, 2024
- [x] **Docs for `RouterRunnable`**: core: Add docs for `RouterRunnable` - [x] **Add docs for `RouterRunnable`**: - **Description:** Add docs for `RouterRunnable`, which was previously missing documentation - **Issue:** #18803 - **Dependencies:** N/A - **Twitter handle:** None
hinthornw
pushed a commit
that referenced
this issue
Apr 26, 2024
- **Description:** Improves the docstring for `class Context` by providing an overview and an example. - **Issue:** #18803
hinthornw
pushed a commit
that referenced
this issue
Apr 26, 2024
**Description:** : Updated the docstring for RunnablePick. Added Overview and an Example for RunnablePick class. **Issue:** : #18803
hinthornw
pushed a commit
that referenced
this issue
Apr 26, 2024
- [x] **docs**: core: Add docs for `RunnableConfigurableFields` - **Description:** Added incode docs for `RunnableConfigurableFields` with example - **Issue:** #18803 - **Dependencies:** NA - **Twitter handle:** NA --------- Co-authored-by: Chester Curme <[email protected]>
Thanks everyone for your help! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
🤖:docs
Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder
good first issue
Good for newcomers
help wanted
Good issue for contributors
Ɑ: Runnables
Related to Runnables
Privileged issue
Issue Content
We would love to get help to add in code documentation to LangChain core to better document LCEL primitives:
Here is an example of a documented runnable:
https://api.python.langchain.com/en/latest/runnables/langchain_core.runnables.base.RunnableLambda.html#langchain_core.runnables.base.RunnableLambda
Here is an example of an undocumented runnable (currently many are undocumented): https://api.python.langchain.com/en/latest/runnables/langchain_core.runnables.passthrough.RunnablePick.html
Acceptance Criteria:
How do i figure out what the runnable does?
Some especially import runnables (note that some of these are base abstractions)
langchain/libs/core/langchain_core/runnables/passthrough.py
Line 315 in bc6249c
langchain/libs/core/langchain_core/runnables/passthrough.py
Line 577 in bc6249c
langchain/libs/core/langchain_core/runnables/configurable.py
Line 44 in bc6249c
langchain/libs/core/langchain_core/runnables/configurable.py
Line 222 in bc6249c
langchain/libs/core/langchain_core/beta/runnables/context.py
Line 309 in bc6249c
The text was updated successfully, but these errors were encountered: