Add in code documentation to core Runnable methods #18804

eyurtsev · 2024-03-08T15:50:55Z

Privileged issue

I am a LangChain maintainer, or was asked directly by a LangChain maintainer to create an issue here.

Issue Content

Hi all!

Core Runnable methods are not documented well enough yet. It would be great to have each of the method include a self-contained usage example that folks can use as a reference.

Documenting these methods well will have a fairly high value impact by making is easier for LangChain users to use core LangChain primitives.

Runnable (

langchain/libs/core/langchain_core/runnables/base.py

Line 103 in bc6249c

class Runnable(Generic[Input, Output], ABC):

):

assign
with_fallbacks
with_retry
pick
pipe
map
with_listeners

RunnableSerializable (

langchain/libs/core/langchain_core/runnables/base.py

Line 1664 in bc6249c

class RunnableSerializable(Serializable, Runnable[Input, Output]):

):

configurable_fields
configurable_alternatives

Acceptance criteria

Documentation includes context
Documentation includes a self contained example in python (including all imports).
Example uses ..code-block: python syntax (see other places in the code as reference).

Please document only on method per PR to make it easy to review and get PRs merged quickly!

liugddx · 2024-03-09T15:09:08Z

@eyurtsev Hi ,assign to me, thanks~

eyurtsev · 2024-03-09T15:35:38Z

Claim a method :)

Ideally the or only documents one method -- it's much faster to review and merge

liugddx · 2024-03-10T01:38:35Z

assign method.

… (docs only) (#18951) **PR message**: ***Delete this entire checklist*** and replace with - **Description:** [a description of the change](docs: Add in code documentation to core Runnable assign method) - **Issue:** the issue #18804

liugddx · 2024-03-15T01:57:33Z

with_fallbacks method.

hrishikeshdkakkad · 2024-03-15T03:31:00Z

/assign - map

@eyurtsev

…d (docs only) (#19104) - Description: [a description of the change] Add in code documentation to core Runnable with_fallbacks method (docs only) - Issue: the issue #18804 @eyurtsev PTAL

@baskaryan

…thod (docs only) (#19192) - **Description:** Add in code documentation to core Runnable with_retry method (docs only) - **Issue:** #18804 @baskaryan @eyurtsev PTAL --------- Co-authored-by: ccurme <chester.curme@gmail.com>

@eyurtsev

- **Issue:** #18804 - @eyurtsev @ccurme PTAL --------- Co-authored-by: Bagatur <baskaryan@gmail.com> Co-authored-by: Bagatur <22008038+baskaryan@users.noreply.github.com>

#19515) **Description:** Docstring for method with_listerners() of class Runnable **Issue:** [Add in code documentation to core Runnable methods #18804](#18804) **Dependencies:** None

@baskaryan

…ly) (#19517) - **Issue:** #18804 - @baskaryan, @eyurtsev

… (docs only) (langchain-ai#18951) **PR message**: ***Delete this entire checklist*** and replace with - **Description:** [a description of the change](docs: Add in code documentation to core Runnable assign method) - **Issue:** the issue langchain-ai#18804

@eyurtsev

…d (docs only) (langchain-ai#19104) - Description: [a description of the change] Add in code documentation to core Runnable with_fallbacks method (docs only) - Issue: the issue langchain-ai#18804 @eyurtsev PTAL

@baskaryan

…thod (docs only) (langchain-ai#19192) - **Description:** Add in code documentation to core Runnable with_retry method (docs only) - **Issue:** langchain-ai#18804 @baskaryan @eyurtsev PTAL --------- Co-authored-by: ccurme <chester.curme@gmail.com>

@eyurtsev

…hain-ai#19395) - **Issue:** langchain-ai#18804 - @eyurtsev @ccurme PTAL --------- Co-authored-by: Bagatur <baskaryan@gmail.com> Co-authored-by: Bagatur <22008038+baskaryan@users.noreply.github.com>

langchain-ai#19515) **Description:** Docstring for method with_listerners() of class Runnable **Issue:** [Add in code documentation to core Runnable methods langchain-ai#18804](langchain-ai#18804) **Dependencies:** None

…figurable_fields (langchain-ai#19722) **Description:** Update to the docstring for class RunnableSerializable, method configurable_fields **Issue:** [Add in code documentation to core Runnable methods langchain-ai#18804](langchain-ai#18804) **Dependencies:** None --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>

… (docs only) (langchain-ai#18951) **PR message**: ***Delete this entire checklist*** and replace with - **Description:** [a description of the change](docs: Add in code documentation to core Runnable assign method) - **Issue:** the issue langchain-ai#18804

@eyurtsev

…d (docs only) (langchain-ai#19104) - Description: [a description of the change] Add in code documentation to core Runnable with_fallbacks method (docs only) - Issue: the issue langchain-ai#18804 @eyurtsev PTAL

@baskaryan

…thod (docs only) (langchain-ai#19192) - **Description:** Add in code documentation to core Runnable with_retry method (docs only) - **Issue:** langchain-ai#18804 @baskaryan @eyurtsev PTAL --------- Co-authored-by: ccurme <chester.curme@gmail.com>

@eyurtsev

…hain-ai#19395) - **Issue:** langchain-ai#18804 - @eyurtsev @ccurme PTAL --------- Co-authored-by: Bagatur <baskaryan@gmail.com> Co-authored-by: Bagatur <22008038+baskaryan@users.noreply.github.com>

langchain-ai#19515) **Description:** Docstring for method with_listerners() of class Runnable **Issue:** [Add in code documentation to core Runnable methods langchain-ai#18804](langchain-ai#18804) **Dependencies:** None

@baskaryan

…ly) (langchain-ai#19517) - **Issue:** langchain-ai#18804 - @baskaryan, @eyurtsev

…igurable_alternatives (langchain-ai#19724) **Description:** Update to the docstring for class RunnableSerializable, method configurable_alternatives **Issue:** [Add in code documentation to core Runnable methods langchain-ai#18804](langchain-ai#18804) **Dependencies:** None --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>

…figurable_fields (langchain-ai#19722) **Description:** Update to the docstring for class RunnableSerializable, method configurable_fields **Issue:** [Add in code documentation to core Runnable methods langchain-ai#18804](langchain-ai#18804) **Dependencies:** None --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>

@baskaryan

…thod (docs only) (langchain-ai#19192) - **Description:** Add in code documentation to core Runnable with_retry method (docs only) - **Issue:** langchain-ai#18804 @baskaryan @eyurtsev PTAL --------- Co-authored-by: ccurme <chester.curme@gmail.com>

@eyurtsev

…hain-ai#19395) - **Issue:** langchain-ai#18804 - @eyurtsev @ccurme PTAL --------- Co-authored-by: Bagatur <baskaryan@gmail.com> Co-authored-by: Bagatur <22008038+baskaryan@users.noreply.github.com>

langchain-ai#19515) **Description:** Docstring for method with_listerners() of class Runnable **Issue:** [Add in code documentation to core Runnable methods langchain-ai#18804](langchain-ai#18804) **Dependencies:** None

@baskaryan

…ly) (langchain-ai#19517) - **Issue:** langchain-ai#18804 - @baskaryan, @eyurtsev

@baskaryan

…thod (docs only) (langchain-ai#19192) - **Description:** Add in code documentation to core Runnable with_retry method (docs only) - **Issue:** langchain-ai#18804 @baskaryan @eyurtsev PTAL --------- Co-authored-by: ccurme <chester.curme@gmail.com>

@eyurtsev

…hain-ai#19395) - **Issue:** langchain-ai#18804 - @eyurtsev @ccurme PTAL --------- Co-authored-by: Bagatur <baskaryan@gmail.com> Co-authored-by: Bagatur <22008038+baskaryan@users.noreply.github.com>

langchain-ai#19515) **Description:** Docstring for method with_listerners() of class Runnable **Issue:** [Add in code documentation to core Runnable methods langchain-ai#18804](langchain-ai#18804) **Dependencies:** None

@baskaryan

…ly) (langchain-ai#19517) - **Issue:** langchain-ai#18804 - @baskaryan, @eyurtsev

spike-spiegel-21 · 2024-04-02T07:58:54Z

Hi @eyurtsev @ccurme is this issue still open? All the methods mentioned above have already been documented I guess. If there are some more, please mention them.

…igurable_alternatives (langchain-ai#19724) **Description:** Update to the docstring for class RunnableSerializable, method configurable_alternatives **Issue:** [Add in code documentation to core Runnable methods langchain-ai#18804](langchain-ai#18804) **Dependencies:** None --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>

…figurable_fields (langchain-ai#19722) **Description:** Update to the docstring for class RunnableSerializable, method configurable_fields **Issue:** [Add in code documentation to core Runnable methods langchain-ai#18804](langchain-ai#18804) **Dependencies:** None --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>

…igurable_alternatives (#19724) **Description:** Update to the docstring for class RunnableSerializable, method configurable_alternatives **Issue:** [Add in code documentation to core Runnable methods #18804](langchain-ai/langchain#18804) **Dependencies:** None --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>

…figurable_fields (#19722) **Description:** Update to the docstring for class RunnableSerializable, method configurable_fields **Issue:** [Add in code documentation to core Runnable methods #18804](langchain-ai/langchain#18804) **Dependencies:** None --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>

… (docs only) (#18951) **PR message**: ***Delete this entire checklist*** and replace with - **Description:** [a description of the change](docs: Add in code documentation to core Runnable assign method) - **Issue:** the issue #18804

@eyurtsev

…d (docs only) (#19104) - Description: [a description of the change] Add in code documentation to core Runnable with_fallbacks method (docs only) - Issue: the issue #18804 @eyurtsev PTAL

@baskaryan

…thod (docs only) (#19192) - **Description:** Add in code documentation to core Runnable with_retry method (docs only) - **Issue:** #18804 @baskaryan @eyurtsev PTAL --------- Co-authored-by: ccurme <chester.curme@gmail.com>

@eyurtsev

- **Issue:** #18804 - @eyurtsev @ccurme PTAL --------- Co-authored-by: Bagatur <baskaryan@gmail.com> Co-authored-by: Bagatur <22008038+baskaryan@users.noreply.github.com>

#19515) **Description:** Docstring for method with_listerners() of class Runnable **Issue:** [Add in code documentation to core Runnable methods #18804](#18804) **Dependencies:** None

@baskaryan

…ly) (#19517) - **Issue:** #18804 - @baskaryan, @eyurtsev

…igurable_alternatives (#19724) **Description:** Update to the docstring for class RunnableSerializable, method configurable_alternatives **Issue:** [Add in code documentation to core Runnable methods #18804](#18804) **Dependencies:** None --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>

…figurable_fields (#19722) **Description:** Update to the docstring for class RunnableSerializable, method configurable_fields **Issue:** [Add in code documentation to core Runnable methods #18804](#18804) **Dependencies:** None --------- Co-authored-by: Chester Curme <chester.curme@gmail.com>

eyurtsev added documentation Improvements or additions to documentation help wanted Good issue for contributors good first issue Good for newcomers Ɑ: lcel Related to LangChain Expression Language (LCEL) labels Mar 8, 2024

dosubot bot added Ɑ: Runnables Related to Runnables 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder labels Mar 8, 2024

eyurtsev removed the documentation Improvements or additions to documentation label Mar 8, 2024

liugddx mentioned this issue Mar 12, 2024

code[patch]: Add in code documentation to core Runnable assign method (docs only) #18951

Merged

liugddx mentioned this issue Mar 15, 2024

code[patch]: Add in code documentation to core Runnable with_fallbacks method (docs only) #19104

Merged

liugddx mentioned this issue Mar 17, 2024

code[patch]: Add in code documentation to core Runnable with_retry method (docs only) #19192

Merged

balachidam21 mentioned this issue Mar 17, 2024

core[patch]: Add in code documentation to core Runnable with_retry method #19207

Closed

liugddx mentioned this issue Mar 21, 2024

code[patch]: Add in code documentation to core Runnable pipe and pick methods (docs only) #19395

Merged

sepiatone mentioned this issue Mar 25, 2024

core[runnables]: docstring for class runnable, method with_listeners() #19515

Merged

liugddx mentioned this issue Mar 25, 2024

code[patch]: Add in code documentation to core Runnable map methods (docs only) #19517

Merged

baskaryan pushed a commit that referenced this issue Mar 26, 2024

docs: Add in code documentation to core Runnable map methods (docs on…

c93d4ea

…ly) (#19517) - **Issue:** #18804 - @baskaryan, @eyurtsev

gkorland pushed a commit to FalkorDB/langchain that referenced this issue Mar 30, 2024

docs: Add in code documentation to core Runnable map methods (docs on…

c84300d

…ly) (langchain-ai#19517) - **Issue:** langchain-ai#18804 - @baskaryan, @eyurtsev

chrispy-snps pushed a commit to chrispy-snps/langchain that referenced this issue Mar 30, 2024

docs: Add in code documentation to core Runnable map methods (docs on…

66efc41

…ly) (langchain-ai#19517) - **Issue:** langchain-ai#18804 - @baskaryan, @eyurtsev

chrispy-snps pushed a commit to chrispy-snps/langchain that referenced this issue Mar 30, 2024

docs: Add in code documentation to core Runnable map methods (docs on…

f63bb7c

…ly) (langchain-ai#19517) - **Issue:** langchain-ai#18804 - @baskaryan, @eyurtsev

hinthornw pushed a commit that referenced this issue Apr 26, 2024

docs: Add in code documentation to core Runnable map methods (docs on…

d912472

…ly) (#19517) - **Issue:** #18804 - @baskaryan, @eyurtsev

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add in code documentation to core Runnable methods #18804

Add in code documentation to core Runnable methods #18804

eyurtsev commented Mar 8, 2024

liugddx commented Mar 9, 2024

eyurtsev commented Mar 9, 2024

liugddx commented Mar 10, 2024

liugddx commented Mar 15, 2024

hrishikeshdkakkad commented Mar 15, 2024

spike-spiegel-21 commented Apr 2, 2024 •

edited

Add in code documentation to core Runnable methods #18804

Add in code documentation to core Runnable methods #18804

Comments

eyurtsev commented Mar 8, 2024

Privileged issue

Issue Content

Acceptance criteria

liugddx commented Mar 9, 2024

eyurtsev commented Mar 9, 2024

liugddx commented Mar 10, 2024

liugddx commented Mar 15, 2024

hrishikeshdkakkad commented Mar 15, 2024

spike-spiegel-21 commented Apr 2, 2024 • edited

spike-spiegel-21 commented Apr 2, 2024 •

edited