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.

Sign up for GitHub

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

Jump to bottom

docs: Make sure all partner packages have README #17545

Closed
1 task done
baskaryan opened this issue Feb 14, 2024 · 6 comments
Closed
1 task done

docs: Make sure all partner packages have README #17545

baskaryan opened this issue Feb 14, 2024 · 6 comments
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

Comments

@baskaryan
Copy link
Collaborator

baskaryan commented Feb 14, 2024 •
edited

Privileged issue

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

Issue Content

Add a good README to each of the libs/partners packages. See langchain-google-vertexai for a good reference.
@baskaryan baskaryan added help wanted Good issue for contributors good first issue Good for newcomers labels Feb 14, 2024
@baskaryan baskaryan pinned this issue Feb 14, 2024
@langchain-ai langchain-ai deleted a comment from dosubot bot Feb 14, 2024
@dosubot dosubot bot added 🤖:docs Changes to documentation and examples, like .md, .rst, .ipynb files. Changes to the docs/ folder 🔌: google Primarily related to Google GenAI or VertexAI integrations labels Feb 14, 2024
@baskaryan baskaryan removed the 🔌: google Primarily related to Google GenAI or VertexAI integrations label Feb 14, 2024
@benfrstr
Copy link

I'd be happy to contribute to this.

@dosubot DosuBot

This comment was marked as resolved.

Sign in to view
@dosubot DosuBot

This comment was marked as resolved.

Sign in to view
@MokshitSurana
Copy link

I'd also like to contribute to this!

@jorgevee jorgevee mentioned this issue Feb 17, 2024
Merged
baskaryan added a commit that referenced this issue Feb 23, 2024
@jorgevee @baskaryan
docs: langchain-anthropic README updates (#17684)
f6a9803 
# PR Message

- **Description:** This PR adds a README file for the Anthropic API in
the `libs/partners` folder of this repository. The README includes:
  - A brief description of the Anthropic package
  - Installation & API instructions
  - Usage examples
  
- **Issue:**
[17545](#17545)
  
- **Dependencies:** None

Additional notes:
This change only affects the docs package and does not introduce any new
dependencies.

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
@mao3267 mao3267 mentioned this issue Feb 23, 2024
Merged
k8si pushed a commit to Mozilla-Ocho/langchain that referenced this issue Feb 23, 2024
@jorgevee @baskaryan @k8si
docs: langchain-anthropic README updates (langchain-ai#17684)
a663576 
# PR Message

- **Description:** This PR adds a README file for the Anthropic API in
the `libs/partners` folder of this repository. The README includes:
  - A brief description of the Anthropic package
  - Installation & API instructions
  - Usage examples
  
- **Issue:**
[17545](langchain-ai#17545)
  
- **Dependencies:** None

Additional notes:
This change only affects the docs package and does not introduce any new
dependencies.

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
This was referenced Feb 23, 2024
Merged
Merged
@amanlai
Copy link

amanlai commented Feb 25, 2024

I'd be happy to contribute. I checked some of them and looks like nvidia-trt is missing a readme but has docs/. OpenAI only has no example usage but links to comprehensive examples. Should these be expanded or are they OK as is?

baskaryan pushed a commit that referenced this issue Feb 26, 2024
@DannyMac180
docs: Additional examples for partners/exa README (#18081)
e42110f 
**Description:** Add additional examples for other modules to
partners/exa README
**Issue:** #17545
**Dependencies:** None
**Twitter handle:** @DannyMcAteer8

---------

Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MBP.attlocal.net>
Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MacBook-Pro.local>
joakimeriksson pushed a commit to joakimeriksson/langchain that referenced this issue Feb 26, 2024
@DannyMac180 @joakimeriksson
docs: Additional examples for partners/exa README (langchain-ai#18081)
1e6c79a 
**Description:** Add additional examples for other modules to
partners/exa README
**Issue:** langchain-ai#17545
**Dependencies:** None
**Twitter handle:** @DannyMcAteer8

---------

Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MBP.attlocal.net>
Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MacBook-Pro.local>
al1p pushed a commit to al1p/langchain that referenced this issue Feb 27, 2024
@jorgevee @baskaryan @al1p-R
docs: langchain-anthropic README updates (langchain-ai#17684)
4478c30 
# PR Message

- **Description:** This PR adds a README file for the Anthropic API in
the `libs/partners` folder of this repository. The README includes:
  - A brief description of the Anthropic package
  - Installation & API instructions
  - Usage examples
  
- **Issue:**
[17545](langchain-ai#17545)
  
- **Dependencies:** None

Additional notes:
This change only affects the docs package and does not introduce any new
dependencies.

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
al1p pushed a commit to al1p/langchain that referenced this issue Feb 27, 2024
@DannyMac180 @al1p-R
docs: Additional examples for partners/exa README (langchain-ai#18081)
e89dd8d 
**Description:** Add additional examples for other modules to
partners/exa README
**Issue:** langchain-ai#17545
**Dependencies:** None
**Twitter handle:** @DannyMcAteer8

---------

Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MBP.attlocal.net>
Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MacBook-Pro.local>
@williamdevena
Copy link
Contributor

Happy to contribute to this.

@williamdevena williamdevena mentioned this issue Feb 27, 2024
Closed
haydeniw pushed a commit to haydeniw/langchain that referenced this issue Feb 27, 2024
@jorgevee @baskaryan
docs: langchain-anthropic README updates (langchain-ai#17684)
513117b 
# PR Message

- **Description:** This PR adds a README file for the Anthropic API in
the `libs/partners` folder of this repository. The README includes:
  - A brief description of the Anthropic package
  - Installation & API instructions
  - Usage examples
  
- **Issue:**
[17545](langchain-ai#17545)
  
- **Dependencies:** None

Additional notes:
This change only affects the docs package and does not introduce any new
dependencies.

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
haydeniw pushed a commit to haydeniw/langchain that referenced this issue Feb 27, 2024
@DannyMac180
docs: Additional examples for partners/exa README (langchain-ai#18081)
c217e93 
**Description:** Add additional examples for other modules to
partners/exa README
**Issue:** langchain-ai#17545
**Dependencies:** None
**Twitter handle:** @DannyMcAteer8

---------

Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MBP.attlocal.net>
Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MacBook-Pro.local>
This was referenced Feb 28, 2024
Merged
Merged
hinthornw added a commit that referenced this issue Feb 29, 2024
@williamdevena @efriis @hinthornw
Updated partners/ibm README (#18268)
87dca8e 
## PR title
partners: changed the README file for the IBM Watson AI integration in
the libs/partners/ibm folder.

## PR message
Description: Changed the README file of partners/ibm following the docs
on https://python.langchain.com/docs/integrations/llms/ibm_watsonx

The README includes:

- Brief description
- Installation
- Setting-up instructions (API key, project id, ...)
- Basic usage:
  - Loading the model
  - Direct inference
  - Chain invoking
  - Streaming the model output
  
Issue: #17545

Dependencies: None

Twitter handle: None

---------

Co-authored-by: Erick Friis <erick@langchain.dev>
Co-authored-by: William FH <13333726+hinthornw@users.noreply.github.com>
hwchase17 pushed a commit that referenced this issue Feb 29, 2024
@williamdevena
Updated partners/fireworks README (#18267)
4121487 
## PR title
partners: changed the README file for the Fireworks integration in the
libs/partners/fireworks folder

## PR message
Description: Changed the README file of partners/fireworks following the
docs on https://python.langchain.com/docs/integrations/llms/Fireworks

The README includes:

- Brief description
- Installation
- Setting-up instructions (API key, model id, ...)
- Basic usage

Issue: #17545

Dependencies: None

Twitter handle: None
baskaryan added a commit that referenced this issue Mar 29, 2024
@mao3267 @baskaryan
docs: update Together README.md (#18004)
833d61a 
## PR message
**Description:** This PR adds a README file for the Together API in the
`libs/partners` folder of this repository. The README includes:
 - A brief description of the package
 - Installation instructions and class introductions
 - Simple usage examples

**Issue:** #17545 

This PR only contains document changes.

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
bechbd pushed a commit to bechbd/langchain that referenced this issue Mar 29, 2024
@mao3267 @baskaryan
docs: update Together README.md (langchain-ai#18004)
0987814 
## PR message
**Description:** This PR adds a README file for the Together API in the
`libs/partners` folder of this repository. The README includes:
 - A brief description of the package
 - Installation instructions and class introductions
 - Simple usage examples

**Issue:** langchain-ai#17545 

This PR only contains document changes.

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
gkorland pushed a commit to FalkorDB/langchain that referenced this issue Mar 30, 2024
@DannyMac180 @gkorland
docs: Additional examples for partners/exa README (langchain-ai#18081)
29b8d55 
**Description:** Add additional examples for other modules to
partners/exa README
**Issue:** langchain-ai#17545
**Dependencies:** None
**Twitter handle:** @DannyMcAteer8

---------

Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MBP.attlocal.net>
Co-authored-by: Daniel McAteer <danielmcateer@Daniels-MacBook-Pro.local>
gkorland pushed a commit to FalkorDB/langchain that referenced this issue Mar 30, 2024
@williamdevena @efriis
@hinthornw @gkorland
Updated partners/ibm README (langchain-ai#18268)
9aa46a5 
## PR title
partners: changed the README file for the IBM Watson AI integration in
the libs/partners/ibm folder.

## PR message
Description: Changed the README file of partners/ibm following the docs
on https://python.langchain.com/docs/integrations/llms/ibm_watsonx

The README includes:

- Brief description
- Installation
- Setting-up instructions (API key, project id, ...)
- Basic usage:
  - Loading the model
  - Direct inference
  - Chain invoking
  - Streaming the model output
  
Issue: langchain-ai#17545

Dependencies: None

Twitter handle: None

---------

Co-authored-by: Erick Friis <erick@langchain.dev>
Co-authored-by: William FH <13333726+hinthornw@users.noreply.github.com>
gkorland pushed a commit to FalkorDB/langchain that referenced this issue Mar 30, 2024
@williamdevena @gkorland
Updated partners/fireworks README (langchain-ai#18267)
bc6fc73 
## PR title
partners: changed the README file for the Fireworks integration in the
libs/partners/fireworks folder

## PR message
Description: Changed the README file of partners/fireworks following the
docs on https://python.langchain.com/docs/integrations/llms/Fireworks

The README includes:

- Brief description
- Installation
- Setting-up instructions (API key, model id, ...)
- Basic usage

Issue: langchain-ai#17545

Dependencies: None

Twitter handle: None
gkorland pushed a commit to FalkorDB/langchain that referenced this issue Mar 30, 2024
@mao3267 @baskaryan @gkorland
docs: update Together README.md (langchain-ai#18004)
a093598 
## PR message
**Description:** This PR adds a README file for the Together API in the
`libs/partners` folder of this repository. The README includes:
 - A brief description of the package
 - Installation instructions and class introductions
 - Simple usage examples

**Issue:** langchain-ai#17545 

This PR only contains document changes.

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
marlenezw pushed a commit to marlenezw/langchain that referenced this issue Apr 2, 2024
@mao3267 @baskaryan @marlenezw
docs: update Together README.md (langchain-ai#18004)
53463f7 
## PR message
**Description:** This PR adds a README file for the Together API in the
`libs/partners` folder of this repository. The README includes:
 - A brief description of the package
 - Installation instructions and class introductions
 - Simple usage examples

**Issue:** langchain-ai#17545 

This PR only contains document changes.

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
@baskaryan baskaryan unpinned this issue Apr 11, 2024
hinthornw pushed a commit that referenced this issue Apr 26, 2024
@mao3267 @baskaryan @hinthornw
docs: update Together README.md (#18004)
0d428e4 
## PR message
**Description:** This PR adds a README file for the Together API in the
`libs/partners` folder of this repository. The README includes:
 - A brief description of the package
 - Installation instructions and class introductions
 - Simple usage examples

**Issue:** #17545 

This PR only contains document changes.

---------

Co-authored-by: Bagatur <baskaryan@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
5 participants
@baskaryan @williamdevena @amanlai @MokshitSurana @benfrstr