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

Revamp getting started. #1016

Merged
merged 9 commits into from
Aug 31, 2023

Conversation

xzdandy
Copy link
Collaborator

@xzdandy xzdandy commented Aug 31, 2023

Inspired by https://ludwig.ai/latest/getting_started/.

Topics will be covered in this PR:

  • Installation Guide
  • Integrate Data Source
  • USE SQL API
  • CREATE DATABASE SQL API

@xzdandy xzdandy linked an issue Aug 31, 2023 that may be closed by this pull request
4 tasks
@xzdandy xzdandy marked this pull request as ready for review August 31, 2023 10:30
@xzdandy xzdandy requested a review from jiashenC August 31, 2023 10:31
@xzdandy xzdandy self-assigned this Aug 31, 2023
@xzdandy xzdandy added this to the v0.3.4 milestone Aug 31, 2023
----------------------------

Instead of using existing models for only inference, you can also train a customized function inside EvaDB with the ``ludwig`` extension.
Run your first SQL query in EvaDB
Copy link
Member

Choose a reason for hiding this comment

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

Others look good to me. Is showing how to run EvaDB necessary here? Since we already have at getting started page.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The motivation is to show user how to run SQL query in EvaDB since we do not have a mysql cli kind of command line client now. We probably also want to modify the Getting Started Page (example https://ludwig.ai/latest/getting_started/), after we complete all sections under that.

@jiashenC
Copy link
Member

The CI seems to run fine, but I cannot build locally due to the following warning.

/Users/jiashenc/Workspace/eva/docs/source/usecases/08-chatgpt.ipynb:140002:image file not readable: source/usecases/chatgpt.png

Any reason this happens for my machine but not CI?

@xzdandy
Copy link
Collaborator Author

xzdandy commented Aug 31, 2023

The CI seems to run fine, but I cannot build locally due to the following warning.

/Users/jiashenc/Workspace/eva/docs/source/usecases/08-chatgpt.ipynb:140002:image file not readable: source/usecases/chatgpt.png

Any reason this happens for my machine but not CI?

I am not be able to reproduce this issue. I have also merged with staging. Could you try again to see if it helps?

@jiashenC
Copy link
Member

The CI seems to run fine, but I cannot build locally due to the following warning.

/Users/jiashenc/Workspace/eva/docs/source/usecases/08-chatgpt.ipynb:140002:image file not readable: source/usecases/chatgpt.png

Any reason this happens for my machine but not CI?

I am not be able to reproduce this issue. I have also merged with staging. Could you try again to see if it helps?

I think it is because leftover file from previous build. git clean -xf resolves the issue.


You can install EvaDB with the vision extension.
With vision extension, you can run queries to do image classification, object detection, and emotion analysis workloads, etc.
* `evadb[vision]` for vision dependencies. With vision dependencies, we can run queries to do image classification, object detection, and emotion analysis workloads, etc.
Copy link
Member

Choose a reason for hiding this comment

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

Would it be better to use ``evadb[vision]``. Single ` (italic) is hard to see in the doc.

@xzdandy xzdandy merged commit 3f05ee8 into staging Aug 31, 2023
@xzdandy xzdandy deleted the 998-complete-the-getting-started-documentation branch August 31, 2023 16:29
hershd23 pushed a commit to hershd23/evadb that referenced this pull request Sep 4, 2023
Inspired by https://ludwig.ai/latest/getting_started/.

Topics will be covered in this PR: 

- Installation Guide
- Integrate Data Source
- USE SQL API
- CREATE DATABASE SQL API
jiashenC pushed a commit that referenced this pull request Sep 5, 2023
Inspired by https://ludwig.ai/latest/getting_started/.

Topics will be covered in this PR:

- Installation Guide
- Integrate Data Source
- USE SQL API
- CREATE DATABASE SQL API
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Complete the Getting-Started Documentation
2 participants