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: update v3 documentation, readme and examples #1526

Merged
merged 6 commits into from
Jan 17, 2025

Conversation

gdcsinaptik
Copy link
Collaborator

@gdcsinaptik gdcsinaptik commented Jan 16, 2025

Important

Update v3 documentation for PandaAI, introducing new features, usage examples, and migration guides, while emphasizing the beta status of the release.

  • Documentation Updates:
    • Update README.md with new usage examples and API key setup.
    • Add beta notice to all v3 documentation files.
    • Update docs/mint.json to reflect new documentation structure.
    • Revise docs/v3/agent.mdx, docs/v3/ai-dashboards.mdx, docs/v3/chat-and-output.mdx, docs/v3/data-ingestion.mdx, docs/v3/data-layer.mdx, docs/v3/dataframes.mdx, docs/v3/getting-started.mdx, docs/v3/introduction.mdx, docs/v3/large-language-models.mdx, docs/v3/overview-nl.mdx, docs/v3/permission-management.mdx, docs/v3/semantic-layer.mdx, docs/v3/share-dataframes.mdx, docs/v3/smart-dataframes.mdx, docs/v3/smart-datalakes.mdx with updated content and examples.
  • New Features:
    • Introduce pai.create() for creating semantic dataframes.
    • Add support for multiple LLMs with configuration via pai.config.set().
    • Enhance .chat() method to support multiple dataframes.
  • Legacy Support:
    • Provide migration guides for SmartDataframe and SmartDatalake to new semantic dataframes.
  • Miscellaneous:
    • Update links and references to new documentation sections.
    • Emphasize the beta status of v3 release across documentation.

This description was created by Ellipsis for 1424d3a. It will automatically update as commits are pushed.

@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Jan 16, 2025
Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Reviewed everything up to bbfa7da in 1 minute and 7 seconds

More details
  • Looked at 207 lines of code in 4 files
  • Skipped 3 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docs/v3/getting-started.mdx:21
  • Draft comment:
    Add 'the' before 'purpose' for correct grammar.
In order to use PandaAI, you need a large language model (LLM). While you can use any LLM, for the purpose of this guide, we are using BambooLLM. 
  • Reason this comment was not posted:
    Comment was on unchanged code.

Workflow ID: wflow_q04vlIkaLAresntp


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Skipped PR review on 4a3b377 because no changed files had a supported extension. If you think this was in error, please contact us and we'll fix it right away.

Copy link

codecov bot commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.80%. Comparing base (63e8c26) to head (010b797).
Report is 134 commits behind head on release/v3.

Additional details and impacted files
@@              Coverage Diff               @@
##           release/v3    #1526      +/-   ##
==============================================
- Coverage       79.09%   76.80%   -2.30%     
==============================================
  Files             149       58      -91     
  Lines            6013     1888    -4125     
==============================================
- Hits             4756     1450    -3306     
+ Misses           1257      438     -819     
Flag Coverage Δ
unittests 76.80% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on aa7ee42 in 40 seconds

More details
  • Looked at 429 lines of code in 19 files
  • Skipped 0 files when reviewing.
  • Skipped posting 5 drafted comments based on config settings.
1. docs/v3/share-dataframes.mdx:11
  • Draft comment:
    The variable df is not defined in this context. It should be df_customers.push() to match the loaded dataframe.
  • Reason this comment was not posted:
    Comment was not on a valid diff hunk.
2. README.md:30
  • Draft comment:
    The variable name file is used instead of df for consistency. Ensure this change is reflected in all examples for clarity.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The code examples in the documentation have been updated to use the new variable name 'file' instead of 'df'. This change should be consistent across all examples for clarity and consistency.
3. docs/v3/agent.mdx:6
  • Draft comment:
    A beta notice has been added to indicate that version 3 is in beta. Ensure this notice is consistent across all documentation files.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The documentation has been updated to include a beta notice for version 3. This is a significant change and should be consistently applied across all documentation files.
4. docs/v3/data-ingestion.mdx:29
  • Draft comment:
    The variable name file is used instead of df for consistency. Ensure this change is reflected in all examples for clarity.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The documentation examples have been updated to use the new variable name 'file' instead of 'df'. This change should be consistent across all examples for clarity and consistency.
5. docs/v3/semantic-layer.mdx:24
  • Draft comment:
    The variable name file is used instead of df for consistency. Ensure this change is reflected in all examples for clarity.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The documentation examples have been updated to use the new variable name 'file' instead of 'df'. This change should be consistent across all examples for clarity and consistency.

Workflow ID: wflow_iUmMpTZ19qQ0G74D


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Jan 17, 2025
Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me! Incremental review on ec86585 in 1 minute and 4 seconds

More details
  • Looked at 559 lines of code in 12 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docs/v3/agent.mdx:153
  • Draft comment:
    Typo in BambooVectorStor. It should be BambooVectorStore. Please correct this.
  • Reason this comment was not posted:
    Comment was not on a valid diff hunk.

Workflow ID: wflow_q2epZM8LfZISnlWS


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❌ Changes requested. Incremental review on 1424d3a in 43 seconds

More details
  • Looked at 141 lines of code in 4 files
  • Skipped 0 files when reviewing.
  • Skipped posting 1 drafted comments based on config settings.
1. docs/v3/smart-dataframes.mdx:61
  • Draft comment:
    The enable_cache option is removed in the new configuration example. If this is intentional, it should be documented to inform users of the change. Otherwise, consider adding it back.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The removal of the enable_cache option in the new configuration might be an oversight. It should be addressed to ensure users are aware of this change.

Workflow ID: wflow_nZiTa9QkONIX8L8u


Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

README.md Outdated Show resolved Hide resolved
Co-authored-by: ellipsis-dev[bot] <65095814+ellipsis-dev[bot]@users.noreply.github.com>
@gventuri gventuri merged commit 1c549a1 into release/v3 Jan 17, 2025
14 of 15 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:XL This PR changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants