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

[docs]: Revamp embedchain docs #799

Merged
merged 7 commits into from
Oct 13, 2023
Merged

[docs]: Revamp embedchain docs #799

merged 7 commits into from
Oct 13, 2023

Conversation

deshraj
Copy link
Collaborator

@deshraj deshraj commented Oct 13, 2023

Description

Updating docs to include the following changes:

  • Add yaml config examples for different configurations like llms, vector databases, and embedding models
  • Add docs about configuring different params for each component in embedchain
  • Clean up old stale docs which is no longer relevant

Type of change

Please delete options that are not relevant.

  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (does not change functionality, e.g. code style improvements, linting)
  • Documentation update

How Has This Been Tested?

  • Unit Test

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

@codecov
Copy link

codecov bot commented Oct 13, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Files Coverage Δ
embedchain/apps/app.py 100.00% <ø> (ø)
embedchain/apps/open_source_app.py 100.00% <ø> (ø)
embedchain/apps/person_app.py 51.35% <100.00%> (ø)
embedchain/bots/base.py 100.00% <100.00%> (ø)
embedchain/config/__init__.py 100.00% <100.00%> (ø)
embedchain/embedchain.py 72.76% <ø> (ø)
embedchain/embedder/vertexai.py 53.84% <100.00%> (ø)
embedchain/factory.py 93.02% <ø> (ø)
embedchain/llm/base.py 76.47% <100.00%> (ø)
embedchain/llm/huggingface.py 93.10% <100.00%> (ø)
... and 3 more

📢 Thoughts on this report? Let us know!.

@deshraj deshraj marked this pull request as ready for review October 13, 2023 22:25
@deshraj deshraj changed the title [wip][docs]: Revamp embedchain docs [docs]: Revamp embedchain docs Oct 13, 2023
@deshraj deshraj merged commit 4a8c50f into main Oct 13, 2023
4 of 5 checks passed
@deshraj deshraj deleted the user/dyadav/update-docs branch October 13, 2023 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant