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.

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

Mention which packages to import in documentation tutorials #466

Open
1 of 12 tasks
ScottS2017 opened this issue Jun 18, 2024 · 8 comments
Open
1 of 12 tasks

Mention which packages to import in documentation tutorials #466

ScottS2017 opened this issue Jun 18, 2024 · 8 comments
Labels
t:documentation Improvements or additions to documentation

Comments

@ScottS2017
Copy link

System Info

I'm trying to do the tutorials and there are many things that aren't correct. One that is a blocker preventing me from learning Retrieval is the fact that it seems like all document loaders are... gone? The tutorial tells you to use TextLoader, JsonLoader, and WebBaseLoader... and this is impossible.

  • TextLoader, doesn't exist.
  • JsonLoader, doesn't exist.
  • WebBaseLoader, doesn't exist.

I want to use the package but I can't use the package if I can't learn the package.

See for yourself. The only place TextLoader appears in the scope is in my tutorial file and one doc comment for SummarizeChain():
image

JsonLoader() only appears in my file:
image

WebBaseLoader has one doc comment in the mapReduce method in summarize.dart, plus my file:
image

When I ran down the BaseDocumentLoader, it's an abstract class that apparently is unused.
image

Related Components

  • doc-loaders
  • doc-transformers
  • prompts
  • llms
  • chat-models
  • output-parsers
  • chains
  • memory
  • stores
  • embeddings
  • retrievers
  • agents

Reproduction

Use the tutorial code at:

Expected behavior

The code should not have errors.

@ScottS2017 ScottS2017 added the t:bug Something isn't working label Jun 18, 2024
@github-project-automation github-project-automation bot moved this to 📋 Backlog in LangChain.dart Jun 18, 2024
@davidmigloz davidmigloz added t:documentation Improvements or additions to documentation and removed t:bug Something isn't working labels Jun 18, 2024
@davidmigloz
Copy link
Owner

davidmigloz commented Jun 18, 2024

Hey @ScottS2017,

All loaders are now in langchain_community package.

It was part of the breaking changes introduced in v0.5.0:
LangChain.dart v0.5.0 migration guide

I need to review all the docs as many tutorials as outdated, but I cannot promise when (any help is appreciated).

@davidmigloz
Copy link
Owner

By the way, GitHub search is normally a good friend 🙂

@davidmigloz
Copy link
Owner

davidmigloz commented Jun 18, 2024

For an up-to-date example about RAG, I recommend you check the wikivoyage_eu example app. If you have any questions, feel free to drop pass by the LangChain.dart Discord server, we have a support channel.

@ScottS2017
Copy link
Author

Sounds good David, thanks. I wish knew enough about the subject to be helpful but at the moment all I will be able to do is point out pain points for learnings. Just think of me as an unpaid Developer Advocate collecting pain points for the engineering team 😆

@davidmigloz
Copy link
Owner

Thanks @ScottS2017, valuable feedback is already a good contribution 🙂

@bettdouglas
Copy link
Contributor

@davidmigloz what do you think if we ported the tutorials to docusaurus.io? I can assist with moving the docs there and trying to have it match the https://python.langchain.com/ docs.

@davidmigloz
Copy link
Owner

Hey @bettdouglas, if you could help with that that would be great!

It was actually in my mind to eventually migrate to docusaurus.io to follow the same structure as the official docs (I should have done that from the beginning... docsify is not actively maintained anymore).

LangChain (the company) also did a big redesign of the official docs recently. They are now following diataxis.fr as their documentation methodology. So moving to their new structure will also be beneficial.

diataxis

I've created a new issue for the migration, we can discuss it there. If you comment on the issue, I can assign it to you 🙂

Thanks for offering your help, I really appreciate it!

@bettdouglas
Copy link
Contributor

Thanks for sharing the link about diataxis.fr. It'll be great learning how to create better documentation using diataxis.

@davidmigloz davidmigloz changed the title Many tutorials are badly broken, Loaders for starters. Mention which packages to import in documentation tutorials Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
t:documentation Improvements or additions to documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

3 participants