Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
blank_issues_enabled: true
contact_links:
- name: Documentation
url: https://github.com/vast-data/VAST-Orbit/tree/master/docs
url: https://github.com/vast-data/Orbit/tree/master/docs
about: Check the documentation for guides and API reference.
- name: Slack Community
url: https://vastsupport.slack.com
Expand Down
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src='https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/vo_logo.png' width="480px">
<img src='https://github.com/vast-data/Orbit/blob/main/assets/img/vo_logo.png' width="480px">
</p>

> **Beta:** VAST Orbit `0.1.x` is the first beta release series. The API and features will change as we work toward a stable `1.0.0`. See [Project Status & Roadmap](#project-status--roadmap).
Expand All @@ -18,8 +18,8 @@
## Trailer Video

<p align="center">
<a href="https://github.com/vast-data/VAST-Orbit/blob/main/docs/source/_static/website/video/vastorbit_trailer_med.mp4">
<img src="docs/source/_static/website/video/vastorbit_intro_poster.png"
<a href="https://github.com/vast-data/Orbit/blob/main/docs/source/_static/website/video/vastorbit_trailer_med.mp4">
<img src="https://github.com/vast-data/Orbit/blob/main/docs/source/_static/website/video/vastorbit_intro_poster.png"
width="100%" alt="VAST Orbit — Trailer (click to watch)">
</a>
</p>
Expand Down Expand Up @@ -61,7 +61,7 @@ Python has become the lingua franca of data science, offering unparalleled flexi

<p align="center">
<!-- TODO: Add architecture diagram -->
<img src='https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/architecture.png' width="100%">
<img src='https://github.com/vast-data/Orbit/blob/main/assets/img/architecture.png' width="100%">
</p>

## Project Status & Roadmap
Expand All @@ -86,7 +86,7 @@ To install VAST Orbit with pip:
pip3 install vastorbit[all]

# Latest commit on main branch
pip3 install git+https://github.com/vast-data/VAST-Orbit.git@main
pip3 install git+https://github.com/vast-data/Orbit.git@main
```

To install VAST Orbit from source, run the following command from the root directory:
Expand Down Expand Up @@ -144,14 +144,14 @@ Dark mode, ideal for extended coding sessions, features a sleek and stylish dark

<p align="center">
<!-- TODO: Add dark theme screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/dark-theme-screenshot.png" width="100%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/dark-theme-screenshot.png" width="100%">
</p>

On the other hand, Light mode serves as the default theme, offering a clean and bright interface for users who prefer a traditional coding ambiance.

<p align="center">
<!-- TODO: Add light theme screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/light-theme-screenshot.png" width="100%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/light-theme-screenshot.png" width="100%">
</p>

Theme can be easily switched by:
Expand Down Expand Up @@ -185,7 +185,7 @@ SELECT version();

<p align="center">
<!-- TODO: Add light theme screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/sql_version.png" width="15%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/sql_version.png" width="15%">
</p>

### SQL Plots
Expand All @@ -203,7 +203,7 @@ To create plots, simply provide the type of plot along with the SQL command.

<p align="center">
<!-- TODO: Add SQL plot screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/sql-plot-screenshot.png" width="90%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/sql-plot-screenshot.png" width="90%">
</p>

### Python and SQL Combo
Expand All @@ -223,7 +223,7 @@ selected_titanic.groupby(columns=["pclass"], expr=["AVG(survived) AS avg_survive

<p align="center">
<!-- TODO: Add SQL plot screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/select_gb.png" width="30%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/select_gb.png" width="30%">
</p>

### Charts
Expand All @@ -234,7 +234,7 @@ A gallery of VAST Orbit-generated charts will be available in the documentation.

<p align="center">
<!-- TODO: Add charts gallery screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/charts-gallery.gif" width="100%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/charts-gallery.gif" width="100%">
</p>

### Complete Machine Learning Pipeline
Expand Down Expand Up @@ -286,7 +286,7 @@ iris_data.scatter(

<p align="center">
<!-- TODO: Add scatter plot screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/scatter-plot.png" width="70%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/scatter-plot.png" width="70%">
</p>

The **Correlation Matrix** is fast and convenient to compute. Users can choose from a wide variety of correlations, including Cramer, Spearman, Pearson, etc.
Expand All @@ -300,7 +300,7 @@ titanic.corr(method="spearman")

<p align="center">
<!-- TODO: Add correlation matrix screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/correlation-matrix.png" width="70%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/correlation-matrix.png" width="70%">
</p>

By turning on the SQL print option, users can see and copy SQL queries:
Expand All @@ -319,7 +319,7 @@ titanic.corr(method="spearman", focus="survived")

<p align="center">
<!-- TODO: Add focused correlation screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/focused-correlation.png" width="50%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/focused-correlation.png" width="50%">
</p>

#### Data Preparation
Expand All @@ -338,7 +338,7 @@ data.outliers_plot(columns="Heights")

<p align="center">
<!-- TODO: Add outliers plot screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/outliers-plot.png" width="70%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/outliers-plot.png" width="70%">
</p>

#### Machine Learning
Expand Down Expand Up @@ -372,7 +372,7 @@ cross_validate(

<p align="center">
<!-- TODO: Add model evaluation screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/model-evaluation.png" width="100%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/model-evaluation.png" width="100%">
</p>

### Loading Predefined Datasets
Expand All @@ -391,7 +391,7 @@ iris_data = load_iris()

<p align="center">
<!-- TODO: Add model evaluation screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/iris-dataset.png" width="70%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/iris-dataset.png" width="70%">
</p>

(2) Use the standard name of the dataset from the schema:
Expand All @@ -404,7 +404,7 @@ iris_data = vo.VastFrame(input_relation="public.iris")

<p align="center">
<!-- TODO: Add model evaluation screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/iris-dataset.png" width="70%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/iris-dataset.png" width="70%">
</p>

## Quickstart
Expand Down Expand Up @@ -452,7 +452,7 @@ vdf = load_titanic()

<p align="center">
<!-- TODO: Add model evaluation screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/light-theme-screenshot.png" width="100%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/light-theme-screenshot.png" width="100%">
</p>

Examine your data:
Expand All @@ -463,7 +463,7 @@ vdf.describe()

<p align="center">
<!-- TODO: Add describe output screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/describe-output.png" width="100%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/describe-output.png" width="100%">
</p>

Print the SQL query with `set_option`:
Expand Down Expand Up @@ -513,7 +513,7 @@ cross_validate(

<p align="center">
<!-- TODO: Add cross-validation results screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/cross-validation.png" width="100%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/cross-validation.png" width="100%">
</p>

Train and deploy the model:
Expand All @@ -532,7 +532,7 @@ model.features_importance()

<p align="center">
<!-- TODO: Add feature importance screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/feature-importance.png" width="100%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/feature-importance.png" width="100%">
</p>

ROC Curve:
Expand All @@ -544,7 +544,7 @@ model.roc_curve()

<p align="center">
<!-- TODO: Add ROC curve screenshot -->
<img src="https://github.com/vast-data/VAST-Orbit/blob/main/assets/img/roc-curve.png" width="70%">
<img src="https://github.com/vast-data/Orbit/blob/main/assets/img/roc-curve.png" width="70%">
</p>

Once trained, the model can be deployed in the database for high-performance predictions _(in-database deployment availability and limitations vary by algorithm — see [Project Status & Roadmap](#project-status--roadmap))_.
Expand Down
6 changes: 3 additions & 3 deletions docs/source/_templates/page.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
at scale, directly on the VAST Data Platform.
</p>
<div class="vast-footer-social">
<a href="https://github.com/vast-data/VAST-Orbit" aria-label="GitHub">
<a href="https://github.com/vast-data/Orbit" aria-label="GitHub">
<svg viewBox="0 0 16 16" fill="currentColor"><path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"/></svg>
</a>
<a href="https://linkedin.com/company/vast-data" aria-label="LinkedIn">
Expand All @@ -73,13 +73,13 @@ <h4>{{ _("Documentation") }}</h4>
<h4>{{ _("Resources") }}</h4>
<a href="https://kb.vastdata.com/">VAST Knowledge Base</a>
<a href="https://www.vastdata.com/platform/database">VAST DataBase</a>
<a href="https://github.com/vast-data/VAST-Orbit">Source on GitHub</a>
<a href="https://github.com/vast-data/Orbit">Source on GitHub</a>
</div>
<div class="vast-footer-col">
<h4>{{ _("Support") }}</h4>
<a href="https://support.vastdata.com/s/">Support Portal</a>
<a href="https://www.vastdata.com/contact">Contact Us</a>
<a href="https://github.com/vast-data/VAST-Orbit/issues">Report an Issue</a>
<a href="https://github.com/vast-data/Orbit/issues">Report an Issue</a>
</div>
<div class="vast-footer-col">
<h4>{{ _("Company") }}</h4>
Expand Down
7 changes: 2 additions & 5 deletions docs/source/about_us.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,7 @@ The story behind VAST Orbit
and SQL functions, multi-source joins across every catalog, and machine-learning
inference — all executed in VAST rather than in Python.

Rather than reinvent that analytics surface, VAST Orbit builds on the proven,
open-source VerticaPy project and re-engineers it for the VAST
DataBase. That heritage is why the library arrived broad and battle-tested,
and why so much of it works the moment you connect.
Rather than reinvent that analytics surface from scratch, VAST Orbit builds on years of proven, open-source engineering, re-engineered for the VAST DataBase. That heritage is why the library arrived broad and battle-tested, and why so much of it works the moment you connect.

The team
--------
Expand Down Expand Up @@ -163,7 +160,7 @@ Report an issue

Found a bug or hit a query that should work but doesn't? Open an issue on GitHub with
a small reproduction and it helps us fix it quickly. File issues at
`github.com/vast-data/vastorbit/issues <https://github.com/vast-data/VAST-Orbit/issues>`__.
`github.com/vast-data/vastorbit/issues <https://github.com/vast-data/Orbit/issues>`__.

Improve the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
2 changes: 1 addition & 1 deletion docs/source/chart_gallery_geo.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Let's utilize the World dataset to demonstrate geospatial capabilities.
africa = world[world["continent"] == "Africa"]

Let's use Africa Education dataset from the vastorbit datasets.
Data is also available `here <https://github.com/vast-data/VAST-Orbit/blob/main/assets/data/understand/africa_education/students.csv>`__.
Data is also available `here <https://github.com/vast-data/Orbit/blob/main/assets/data/understand/africa_education/students.csv>`__.

.. code-block:: python

Expand Down
6 changes: 3 additions & 3 deletions docs/source/cicd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -213,15 +213,15 @@ For Contributors

.. tip::

Set up pre-commit hooks to run checks automatically before each commit. See our `contributing guide <https://github.com/vast-data/VAST-Orbit/blob/main/CONTRIBUTING.md>`__ for setup instructions.
Set up pre-commit hooks to run checks automatically before each commit. See our `contributing guide <https://github.com/vast-data/Orbit/blob/main/CONTRIBUTING.md>`__ for setup instructions.

____

Pipeline Status
---------------

.. image:: https://github.com/vast-data/VAST-Orbit/workflows/CI/badge.svg
:target: https://github.com/vast-data/VAST-Orbit/actions
.. image:: https://github.com/vast-data/Orbit/workflows/CI/badge.svg
:target: https://github.com/vast-data/Orbit/actions
:alt: CI Status

.. image:: https://codecov.io/gh/vast-data/vastorbit/branch/main/graph/badge.svg
Expand Down
6 changes: 3 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -552,7 +552,7 @@
},
{
"name": "GitHub",
"url": "https://github.com/vast-data/VAST-Orbit",
"url": "https://github.com/vast-data/Orbit",
"html": """
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"></path>
Expand Down Expand Up @@ -587,7 +587,7 @@
<a class="top-button" href="./getting_started.html" id="sitenav-solutions">Getting Started</a>
<a class="top-button" href="./about_us.html" id="sitenav-solutions">About Us</a>
<a class="top-button" href="./api.html" id="sitenav-solutions">API Reference</a>
<a class="top-button" href="https://github.com/vast-data/VAST-Orbit" id="sitenav-solutions">GitHub</a>
<a class="top-button" href="https://github.com/vast-data/Orbit" id="sitenav-solutions">GitHub</a>
</div>
</div>
<div class="search-top-dropdown">
Expand All @@ -612,7 +612,7 @@
<a class="top-button" href="./index.html" id="sitenav-solutions">Home</a>
<a class="top-button" href="./about_us.html" id="sitenav-solutions">About Us</a>
<a class="top-button" href="./api.html" id="sitenav-solutions">API Reference</a>
<a class="top-button" href="https://github.com/vast-data/VAST-Orbit" id="sitenav-solutions">GitHub</a>
<a class="top-button" href="https://github.com/vast-data/Orbit" id="sitenav-solutions">GitHub</a>
</div>
<div class='top_search'>
<form class='sidebar-search-container sidebar-search-container_top' method='get' action='search.html' role='search'>
Expand Down
6 changes: 3 additions & 3 deletions docs/source/contribution_guidelines.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Bug Reports

**Found a bug?** Submit an issue with complete reproduction steps.

.. button-link:: https://github.com/vast-data/VAST-Orbit/issues
.. button-link:: https://github.com/vast-data/Orbit/issues
:color: primary
:outline:

Expand Down Expand Up @@ -60,7 +60,7 @@ Feature Requests

**Have an idea?** We're always open to suggestions for improving VAST Orbit.

.. button-link:: https://github.com/vast-data/VAST-Orbit/issues
.. button-link:: https://github.com/vast-data/Orbit/issues
:color: primary
:outline:

Expand Down Expand Up @@ -100,7 +100,7 @@ Community
**Get Help:**

- |i-chat| **Slack**: `vastsupport.slack.com <https://vastsupport.slack.com>`__
- |i-error| **Issues**: https://github.com/vast-data/VAST-Orbit/issues
- |i-error| **Issues**: https://github.com/vast-data/Orbit/issues

**Stay Updated:**

Expand Down
2 changes: 1 addition & 1 deletion docs/source/contribution_guidelines_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Quick Start
.. code-block:: bash

# 1. Fork and clone
git clone https://github.com/vast-data/VAST-Orbit.git
git clone https://github.com/vast-data/Orbit.git
cd vastorbit

# 2. Create branch
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contribution_guidelines_code_auto_doc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ This section covers setting up Sphinx to automate documentation. **(Future: This

.. code-block:: bash

git clone https://github.com/vast-data/VAST-Orbit.git
git clone https://github.com/vast-data/Orbit.git
cd vastorbit

**2. Create docs Folder**
Expand Down
2 changes: 1 addition & 1 deletion docs/source/contribution_guidelines_code_setting_up.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ ____
Step 1: Git
===========

Fork the project on `Github <https://github.com/vast-data/VAST-Orbit>`__ and check out your copy locally.
Fork the project on `Github <https://github.com/vast-data/Orbit>`__ and check out your copy locally.

.. code-block:: bash

Expand Down
2 changes: 1 addition & 1 deletion docs/source/examples_business_churn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ You can skip the below cell if you already have an established connection.

vo.connect("VASTDSN")

Let's create a VastFrame of the dataset. The dataset is available `here <https://github.com/vast-data/VAST-Orbit/blob/main/assets/data/business/churn/customers.csv>`__.
Let's create a VastFrame of the dataset. The dataset is available `here <https://github.com/vast-data/Orbit/blob/main/assets/data/business/churn/customers.csv>`__.

.. code-block:: ipython

Expand Down
2 changes: 1 addition & 1 deletion docs/source/examples_business_football.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Football
=========

In this example, we use the ``football`` dataset to predict the outcomes of games between various teams. You can download the dataset `here <https://github.com/vast-data/VAST-Orbit/blob/main/assets/data/business/football/games.csv>`__.
In this example, we use the ``football`` dataset to predict the outcomes of games between various teams. You can download the dataset `here <https://github.com/vast-data/Orbit/blob/main/assets/data/business/football/games.csv>`__.

- **date:** Date of the game.
- **home_team:** Home Team.
Expand Down
Loading
Loading