Skip to content

Commit

Permalink
fix user reference
Browse files Browse the repository at this point in the history
  • Loading branch information
gaurav274 committed Aug 25, 2023
1 parent 761aaae commit b7754ae
Show file tree
Hide file tree
Showing 7 changed files with 53 additions and 405 deletions.
10 changes: 8 additions & 2 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,11 @@ div.sidebar-tree .caption>.reference {

div.sidebar-tree .toctree-l1>.current.reference.internal {
color: var(--orange); /* Set your desired background color */
}
}

div.sidebar-tree .toctree-l2>.current.reference.internal {
color: var(--orange); /* Set your desired background color */
}

div.sidebar-tree .toctree-l1>.reference {
color: #646776;
Expand All @@ -69,7 +73,9 @@ div.sidebar-tree .toctree-l1>.reference:hover {
color: var(--orange);
}


div.sidebar-tree .toctree-l2>.reference:hover {
color: var(--orange);
}

/* div.sidebar-tree ul {
border-bottom: 1px solid var(--orange);
Expand Down
44 changes: 23 additions & 21 deletions docs/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,23 +26,10 @@ parts:
- caption: User Reference
chapters:
- file: source/reference/api
title: API
title: Python API

- file: source/reference/udfs/hf
title: Hugging Face UDFs
- file: source/reference/udfs/openai
title: OpenAI UDFs
- file: source/reference/udfs/yolo
title: YOLO UDFs
- file: source/reference/udf
title: User-Defined Functions
- file: source/reference/udfs/custom
title: Custom User-Defined Function
- file: source/reference/model_train
title: Customized UDFs and Model Train/Finetune

- file: source/reference/evaql
title: Query Language
title: Eva Query Language
sections:
- file: source/reference/evaql/load
- file: source/reference/evaql/select
Expand All @@ -54,14 +41,29 @@ parts:
- file: source/reference/evaql/delete
- file: source/reference/evaql/rename

- file: source/reference/io
title: IO Descriptors
- file: source/reference/udfs/index
title: Models
sections:
- file: source/reference/udfs/hf
title: Hugging Face
- file: source/reference/udfs/openai
title: OpenAI
- file: source/reference/udfs/yolo
title: YOLO
- file: source/reference/udfs/custom
title: Custom Model
- file: source/reference/udfs/model-train
title: Model Train/Finetune


# - file: source/reference/io
# title: IO Descriptors

- file: source/reference/gpu
title: Configure GPU
# - file: source/reference/gpu
# title: Configure GPU

- file: source/overview/docker
title: Docker
# - file: source/overview/docker
# title: Docker

- caption: Benchmarks
chapters:
Expand Down
6 changes: 3 additions & 3 deletions docs/source/contribute/debugging.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Debugging
-----
-----------

We recommend Visual Studio Code with a debugger for debugging EvaDB. This tutorial presents a detailed step-by-step process of using the debugger.

Setup debugger
====
================

1. Install the `Python extension <https://marketplace.visualstudio.com/items?itemName=ms-python.python>`__ in Visual Studio Code.

Expand All @@ -20,7 +20,7 @@ Setup debugger
:width: 1200

Alternative: Manually Setup Debugger for EvaDB
====
====================================================

When you press the debug icon, you will be given an option to create a ``launch.json`` file.

Expand Down
17 changes: 9 additions & 8 deletions docs/source/contribute/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
Contributing
----
----------------

We welcome all kinds of contributions to EvaDB.

- `Code reviews <https://github.com/georgia-tech-db/evadb/pulls>`_
- `Improving documentation <https://github.com/georgia-tech-db/evadb/tree/master/docs>`_
- `Tutorials and applications <https://github.com/georgia-tech-db/evadb/tree/master/tutorials>`_
- New features
- :doc:`New features <source/contribute/index>`

Setting up the Development Environment
=====
=====================================================

First, you will need to checkout the repository from GitHub and build EvaDB from
the source. Follow the following instructions to build EvaDB locally. We recommend using a virtual environment and the pip package manager.
Expand All @@ -33,7 +34,7 @@ After installing the package locally, you can make changes and run the test case
Testing
====
=========

Check if your local changes broke any unit or integration tests by running the following script:

Expand All @@ -55,7 +56,7 @@ file.
python -m pytest test/integration_tests/test_select_executor.py -k 'test_should_load_and_select_in_table'
Submitting a Contribution
====
============================

Follow the following steps to contribute to EvaDB:

Expand All @@ -76,7 +77,7 @@ Follow the following steps to contribute to EvaDB:
python script/formatting/formatter.py
Code Style
====
============

We use the `black <https://github.com/psf/black>`__ code style for
formatting the Python code. For docstrings and documentation, we use
Expand All @@ -97,7 +98,7 @@ formatting the Python code. For docstrings and documentation, we use
bool: The return value. True for success, False otherwise.
Debugging
====
============
We recommend using Visual Studio Code with a debugger for developing EvaDB. Here are the steps for setting up the development environment:
Expand All @@ -115,12 +116,12 @@ We recommend using Visual Studio Code with a debugger for developing EvaDB. Here
:width: 1200
Architecture Diagram
====
========================
.. image:: ../../images/evadb/evadb-arch.png
:width: 1200
Troubleshooting
====
====================
If the test suite fails with a `PermissionDenied` exception, update the `path_prefix` attribute under the `storage` section in the EvaDB configuration file (``~/.evadb/evadb.yml``) to a directory where you have write privileges.
10 changes: 10 additions & 0 deletions docs/source/reference/udfs/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
Models
------------------------------------------

EvaDB facilitates the utilization of thin wrappers around deep learning, commonly referred to as User Defined Functions (UDFs). These UDFs enable the incorporation of deep learning models into AI queries.

This section compiles a comprehensive catalog of the model integrations that EvaDB supports.

Please refer to the following table of contents for easy navigation:

.. tableofcontents::
File renamed without changes.
Loading

0 comments on commit b7754ae

Please sign in to comment.