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 docs for sql, create, links, examples #1571

Merged
merged 2 commits into from
Jan 31, 2025
Merged

Conversation

gdcsinaptik
Copy link
Collaborator

@gdcsinaptik gdcsinaptik commented Jan 31, 2025

Important

This pull request updates the PandaAI documentation to include new semantic layer features, improve data ingestion instructions, and enhance overall clarity and structure.

  • Semantic Layer:
    • Introduces new documentation for creating semantic layer schemas using pai.create() in semantic-layer/new.mdx.
    • Adds documentation for working with views in semantic-layer/views.mdx.
    • Removes outdated data-layer.mdx and dataframes.mdx.
  • Data Ingestion:
    • Updates SQL database support to include CockroachDB in data-ingestion.mdx.
    • Simplifies SQL extension installation instructions.
  • Documentation Updates:
    • Updates links and references to the semantic layer across multiple files.
    • Fixes typos and improves clarity in ai-dashboards.mdx, chat-and-output.mdx, and cli.mdx.
    • Updates mint.json to reflect new documentation structure.
  • Miscellaneous:
    • Updates LLM setup instructions in large-language-models.mdx.
    • Adds sandbox environment details in privacy-security.mdx.
    • Removes example projects and advanced views links from getting-started.mdx and introduction.mdx.

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

Copy link
Contributor

@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 4b4aa1e in 48 seconds

More details
  • Looked at 658 lines of code in 8 files
  • Skipped 0 files when reviewing.
  • Skipped posting 7 drafted comments based on config settings.
1. docs/v3/chat-and-output.mdx:111
  • Draft comment:
    Ensure that response.last_code_executed is the intended attribute to use here, as it reflects the executed code rather than the generated code. This change should align with the context of inspecting the executed code.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The change from response.last_code_generated to response.last_code_executed is correct, assuming the intent is to show the executed code rather than the generated code. This aligns with the context of inspecting the code that was executed.
2. docs/v3/data-ingestion.mdx:34
  • Draft comment:
    The name parameter has been removed from the pai.create method. Ensure that this change is intentional and that the name is either inferred from the path or no longer necessary. This change is also present in other files like getting-started.mdx.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The removal of the name parameter in the pai.create method is consistent across multiple files. This suggests a deliberate change in the API, possibly to simplify the method signature or because the name is now inferred from the path.
3. docs/v3/large-language-models.mdx:46
  • Draft comment:
    The import statement has been changed from pandasai-openai to pandasai_openai. Ensure that this change reflects the correct package name and is consistent with the installed package. This change is also present in other sections for different LLMs.
  • Reason this comment was not posted:
    Confidence changes required: 50%
    The change from pandasai-openai to pandasai_openai in the import statements is consistent across multiple files. This suggests a change in the package naming convention, possibly to align with Python's module naming standards.
4. docs/v3/semantic-layer.mdx:172
  • Draft comment:
    If the create method for SQL databases is a new feature, ensure that the documentation is updated accordingly and that there are corresponding unit tests to verify its functionality.
  • Reason this comment was not posted:
    Comment did not seem useful.
5. docs/v3/data-ingestion.mdx:62
  • Draft comment:
    If the create method for SQL databases is a new feature, ensure that the documentation is updated accordingly and that there are corresponding unit tests to verify its functionality.
  • Reason this comment was not posted:
    Marked as duplicate.
6. docs/v3/data-ingestion.mdx:64
  • Draft comment:
    If the create method for SQL databases is a new feature, ensure that the documentation is updated accordingly and that there are corresponding unit tests to verify its functionality.
  • Reason this comment was not posted:
    Marked as duplicate.
7. docs/v3/semantic-layer.mdx:179
  • Draft comment:
    If the create method for SQL databases is a new feature, ensure that the documentation is updated accordingly and that there are corresponding unit tests to verify its functionality.
  • Reason this comment was not posted:
    Marked as duplicate.

Workflow ID: wflow_JYlDxhodmcuHeuBF


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

Copy link

codecov bot commented Jan 31, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 82.73%. Comparing base (4ca228f) to head (4b4aa1e).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1571   +/-   ##
=======================================
  Coverage   82.73%   82.73%           
=======================================
  Files          66       66           
  Lines        2410     2410           
=======================================
  Hits         1994     1994           
  Misses        416      416           
Flag Coverage Δ
unittests 82.73% <ø> (ø)

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.

@gventuri gventuri changed the title Updated docs for sql, create, links, examples docs: update docs for sql, create, links, examples Jan 31, 2025
@gventuri gventuri merged commit b0305ef into main Jan 31, 2025
7 of 13 checks passed
Copy link
Contributor

@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 6499801 in 54 seconds

More details
  • Looked at 1097 lines of code in 13 files
  • Skipped 0 files when reviewing.
  • Skipped posting 2 drafted comments based on config settings.
1. docs/mint.json:61
  • Draft comment:
    Missing comma after "Data layer". Add a comma to separate the group name from the pages array.
  • Reason this comment was not posted:
    Comment looked like it was already resolved.
2. docs/v3/semantic-layer/new.mdx:132
  • Draft comment:
    There's a missing comma after the "sale_date" key in the dictionary. Please add a comma to separate the key-value pairs.
            "name": "sale_date",
  • Reason this comment was not posted:
    Marked as duplicate.

Workflow ID: wflow_UoJj8dr7XoULrldm


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.

"description": "Unique identifier for each sale"
},
{
"name": "sale_date"
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a missing comma after the "sale_date" key in the dictionary. Please add a comma to separate the key-value pairs.

Suggested change
"name": "sale_date"
"name": "sale_date",

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.

2 participants