From 09b09a62dbacdf4e3388442363946694c4570f68 Mon Sep 17 00:00:00 2001
From: exift <117622198+exift@users.noreply.github.com>
Date: Wed, 23 Nov 2022 18:04:19 +0800
Subject: [PATCH 1/3] Update README.md
updated nov.23.
---
README.md | 249 +++++++++++++++++++++++++++++++++---------------------
1 file changed, 151 insertions(+), 98 deletions(-)
diff --git a/README.md b/README.md
index e754f757..3923e331 100644
--- a/README.md
+++ b/README.md
@@ -1,61 +1,123 @@
-# Rath
+Welcome to the RATH Project
+
+
+
+
RATH
+
+ 
+
+
Your Open Source Augmented Analytics Alternative for Business Intelligence
+
+
+
+## Welcome
+
+Welcome to the [RATH Project](https://kanaries.net/). We are so excited to have you as part of our community.
+
+**RATH** is an open-source alternative to Data Analysis tools such as Tableau. It automates your Explotoary Data Analysis workflow with an AI-enhanced engine by discovering patterns and insights and presents multi-dimensional data visualization.
+
+**RATH** is an ongoing project, actively being developed and maintained by a group of data analysts, developers and community ethuastists. We are a group of people who are passionate about data visualization, data automation and exploratory data analysis (EDA).
+
+πͺJoin the RATH Project, let's build it up!πͺ
+
+[](https://github.com/Kanaries/Rath)
+
+*Visit our [official website](https://kanaries.net) for more information about the RATH proejct.*
+
+## Table of contents
+
+| [Why use RATH?](#why-use-rath) | [Getting started](#getting-started) | [Try RATH now](#try-rath-now) | [Feature highlights](#feature-highlights) | [Walkthroughs](#walkthroughs) | [Developer Documentation](#developer-documentation) | [Community](#community) | [Contributing](#contributing) | [Top commitors](#top-commitors) | [License (AGPL)](#license-agpl) |
+
+## Why use RATH?
+
+- Effortlessly automate your Exploratory Data Analysis process with a no-code, Tableau-like UI.
+- Generate editable and insightful data visualizations. Freely modify your visualizations with Vega/Vega-lite.
+- Support a variety of database types.
+- Flexible copilot to assist your data exploration journey by learning your interests with AI.
+- Paint your data to explore your datasets directly with Data Painter.
+- RESTful API for programmatic RATH integration.
+
+## Get started
+
+### Try RATH now
+
++ [RATH Cloud](https://rath.kanaries.net/)
++ [Download desktop version](https://kanaries.net/#/products)
+
+### Feature highlights
+- π [Data profiling](https://kanaries.net/docs/data-source): overview your data source with one click. You can upload, sample, define dimensions and measures, perform data cleaning and more complicated computing upon your data source.
+
+- π€ [Mega-auto exploration](https://kanaries.net/docs/auto-explore): a fully-automated way to explore your data set and visualize your data with one click. Leave everything to RATH, simply pick the associate view that inspires you the most.
+
+- π [Semi-auto exploration](https://kanaries.net/docs/semi-auto-explore): The middle ground between a fully automated Data Exploration and Tableau-like manual exploration. RATH will work as your copilot, learn your interests and uses AI to generate relevant recommendations for you.
+
+- π¨ [Data painter](https://kanaries.net/docs/data-painter): An interactive, instinctive yet powerful tool for exploratory data analysis by directly coloring your data, with further analytical features.
+
+- π Wanna learn more about RATH? Visit our [Free online Courses](https://kanaries.net/docs/rath-academy): Access learning materials, detailed instructions and skill tests for **FREE**!
+
+## Walkthroughs
+### View statistics from your data source
+
+### Configure your dataset
+
+
+### One-click data analysis with Mega-auto Exploration
+
+
+### Generate more associate visualizations in Mega-auto Exploration
+
-[](https://twitter.com/kanaries_data)
+### Use RATH as the Data Analysis copilot in Semi-auto Exploration
+
-
-
-
-
+### RATH automatically learns your interest and generate recommendations
+
+### Manually explore your data with a Tableau-like module
+
-
+
-RATH is an OpenSource automated data exploration tool that can help you automate discovery patterns and insights and generate charts and dashboards from multi-dimensional data. It uses an AI-enhanced engine to automate the working flow in data analysis. You can regard RATH as a copilot in data analysis.
-
- It is not only an open source replacement of tableau but a version with more automation power, including auto insights discovery, predictive interaction, and visual recommendation.
-
-+ Try RATH [here](https://rath.kanaries.net)
-+ visit our official website[kanaries website](https://kanaries.net)
-+ [π Quick View of RATH's Exploratory Data Analysis](https://medium.com/@observedobserver/quick-view-of-raths-exploratory-data-analysis-65c71866eca5)
-
-## Introduction
-
-Rath is an auto EDA tool (or Augmented Analytic BI), which automates exploring your dataset and discovering interesting patterns and relations, recommending expressiveness and effective visualizations.
-
-Rath provides a different level of automation for different scenarios and users. For instance, the 'MegaAutomation' module provides full automation. Connect your data, and click 'analysis'. Rath will do all the exploration and analysis work for you. Rath will find some insights and patterns in data and generate charts/dashboards for you. The 'SemiAutomation' module is a semi-automation analysis system that can be controlled to focus on your thoughts more. 'Manual Exploration' module is a manual data analysis and visualization tool for whom with specific analysis purpose.
-
-Rath can auto-generate high-dimensional visualization containing complex patterns, while most other auto-EDA tools only provide simple low-dimensional charts with basic statistics patterns. Its means you can use Rath to explore the data to a deep level and find more insights.
-
-Here are the main parts of Rath,
-
-### DataSource
-DataSource board is for data uploading, sampling(currently support stream data, which means there is no limit on the size of the file you uploaded), cleaning, and defining fields type(dimensions, measures). In visual insights, we regard dimensions as independent variables or features and measures as dependent variables or targets.
-
-
-
-
-
-### Mega Automation
-
-Rath automates exploring your dataset and discovering interesting patterns, and relations, recommending expressiveness and effective visualizations.
-
-
-If some of the recommendations catch your interest, you can click the associate button, and Rath will associate more related insights for you.
-
-
-
-If you have some very specific target, you can switch to a manual EDA tool inside Rath called Graphic Walker.
-
-### Manual Exploration
-Graphic Walker is a lite tableau/polaris style visual analysis app, which is also based on Wilkinson's Grammer of Graphics. It is used for cases when users have specific analytic targets or want to analyze further results based on the recommended results by Rath's auto insights.
-
-
-
-We use similar visualization specification rules in polaris, which is friendly to users who are familiar with tableau.
-
-
-
-Manual Exploration is an independent embedding module. You can use it independently in your own app. See more details in `packages/graphic-walker/README.md`
+Manual Exploration is an independent embedding module. You can use it independently in your apps. See more details in `packages/graphic-walker/README.md`
```bash
yarn add @kanaries/graphic-walker
@@ -64,63 +126,47 @@ yarn add @kanaries/graphic-walker
npm i --save @kanaries/graphic-walker
```
-### SemiAutomation
-Discovery or knowledge build module is a semi-automated data exploration system. It automates step by step and tries to understand what the users are thinking in real-time. Users can tell Rath what they are more interested in and Rath will focus more on the subset user care about.
-
-
-
-
-
-
-
-### Dashboard
-Generate interactive dashboards for yours. Rath will figure out sets of visualizations of which contents are connected to each other and can be used to analyze a specific problem.
+## Supported Databases
-You can also specify parts of the dashboard, and RATH
-will figure out the best fits for the rest of the dashboard.
+RATH can query data from any SQL-speaking datastore or data engine (Presto, Trino, Athena, [and more](https://superset.apache.org/docs/databases/installing-database-drivers/)) that has a Python DB-API driver and a SQLAlchemy dialect.
-### Notebook (deprecated)
-Notebook is a board for the user to know what happened in the automatic analysis process and how RATH uses visual-insights. It shows how decisions are made by the application and provide an interactive interface to adjust some of the parameters and operators used by the algorithm.
+Here are some of the major database solutions that are supported:
-### Explainer (deprecated)
-Explainer uses several insight discovery algorithms to detect what the specific insight type is shown in a visualization recommended. Explainer is an extension of B. Tang's Top K insight paper[4].
+
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+
+If you want to add support for more database types or data engines, feel free to [contact us](https://kanaries.net/docs#contact-us)
-You can also use Graphic Walker as a lite tableau style analysis app independently. It can be used as an independent app or an embedding module.
+## Developer Documentation
-more details can be found in README.md in graphic-walker folder.
+We encourage you to check out our [RATH Docs](https://kanaries.net/docs) for references and guidance. RATH Docs are scripted and maintained by technical writers and editors who collectively follow a standardized [style guide](https://kanaries/docs/documentation-style-guide) to produce clear and consistent documentation.
-## Docs
-+ [docs](https://kanaries.net)
+## Community
+[RATH community](https://kanaries.net/community) is a place to have open discussions on features, voice your ideas, or get help with general questions. Get onboard with us through the following channels:
+Our developer community is the backbone of the ongoing RATH project. We sincerely welcome you to [join our community](join), participate in the conversation and stay connected with us for the latest updates. Feel free to [contribute to the RATH project](contribution-guide), submit any issues on our GitHub page, or split your grand new ideas in our chats.
-## Usage
+
+
-### Try it
-+ on Github Pages(Stable version) [App](https://kanaries.github.io/Rath/)
-+ on Kanaries Website [App](https://kanaries.net/)
+## Contributing
-### Download Desktop Version
-- [MacOS](https://ch-resources.oss-cn-shanghai.aliyuncs.com/downloads/rath/Kanaries%20Rath-0.1.0.dmg)
-- [Windows](https://ch-resources.oss-cn-shanghai.aliyuncs.com/downloads/rath/Kanaries%20Rath-0.1.0-win.zip)
-
-### deploy
-
-Rath now runs all the computation tasks on webworker. For some large datasets, Rath will use indexedDB to avoid too much memory cost of browsers. For larger datasets (>100MB), Rath can put some of its computation to computation engine support SQL query(such as clickhouse). If you are interested in a server version, check the older version or contact us.
-
-#### deploy connector service
-RATH requires a database connector to connect common databases. You need to deploy `apps/connector` and then you can connect a number of common databases as datasource.
-
-#### OLAP Service
-Connector service is used as a pure datasource, RATH fetches the data from the bases and loads them into memory.
-
-For larger datasets, or if you can access a high performance OLAP service (such as a clusters of clickhouse). You can start `packages/connectors` which is a OLAP service connector. Not only will it fecthes data from OLAP, but use it as a computation engine as well. RATH
- will push SQL query to the OLAP services instead of computate those tasks in its own engine.
-
-
-## Documentation
-+ [π Quick View of RATH's Exploratory Data Analysis](https://medium.com/@observedobserver/quick-view-of-raths-exploratory-data-analysis-65c71866eca5)
+Please check out the [Contributing to RATH guide](https://kanaries.net/docs/contribution_guide)
+for guidelines about how to proceed.
## LICENSE (AGPL)
Rath is an automated data analysis and visualization tool (auto-EDA).
@@ -137,3 +183,10 @@ GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see .
+
+
+
+ Have fun with data! β€οΈ
+
+
+[β¬ Back to Top](#welcome)
From 0afbe2acaf29b8f1d0ea8d1eced8eb0c7c73784f Mon Sep 17 00:00:00 2001
From: jojocys <270001151@qq.com>
Date: Wed, 23 Nov 2022 18:43:31 +0800
Subject: [PATCH 2/3] fix: docs desc
---
README.md | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 3923e331..1674a6cc 100644
--- a/README.md
+++ b/README.md
@@ -4,7 +4,7 @@ Welcome to the RATH Project
RATH
-
+
Your Open Source Augmented Analytics Alternative for Business Intelligence
@@ -52,11 +52,11 @@ Welcome to the RATH Project
Welcome to the [RATH Project](https://kanaries.net/). We are so excited to have you as part of our community.
-**RATH** is an open-source alternative to Data Analysis tools such as Tableau. It automates your Explotoary Data Analysis workflow with an AI-enhanced engine by discovering patterns and insights and presents multi-dimensional data visualization.
+**RATH** is an open-source alternative to Data Analysis and Visualization tools such as Tableau. It automates your Explotoary Data Analysis workflow with an Augmented Analytic engine by discovering patterns, insights, causals and presents those insights with powerful auto-generated multi-dimensional data visualization.
-**RATH** is an ongoing project, actively being developed and maintained by a group of data analysts, developers and community ethuastists. We are a group of people who are passionate about data visualization, data automation and exploratory data analysis (EDA).
+**RATH** is an ongoing project, actively being developed and maintained by a group of data scientists, developers and community ethuastists. We are a group of people who are passionate about creating the next generation of data analytic tool.
-πͺJoin the RATH Project, let's build it up!πͺ
+πͺJoin us, let's build it up!πͺ
[](https://github.com/Kanaries/Rath)
@@ -68,12 +68,13 @@ Welcome to the [RATH Project](https://kanaries.net/). We are so excited to have
## Why use RATH?
-- Effortlessly automate your Exploratory Data Analysis process with a no-code, Tableau-like UI.
+- Effortlessly automate your Exploratory Data Analysis process with a no-code UI.
- Generate editable and insightful data visualizations. Freely modify your visualizations with Vega/Vega-lite.
- Support a variety of database types.
-- Flexible copilot to assist your data exploration journey by learning your interests with AI.
+- Flexible copilot to assist your data exploration journey.
- Paint your data to explore your datasets directly with Data Painter.
-- RESTful API for programmatic RATH integration.
+- Causal discovery and explainer module to help you understand complex data patterns.
+- Open APIs and SDK for embeding requirements.
## Get started
@@ -139,13 +140,12 @@ Here are some of the major database solutions that are supported:
-
+ 
-
+ 
-
If you want to add support for more database types or data engines, feel free to [contact us](https://kanaries.net/docs#contact-us)
@@ -156,7 +156,7 @@ We encourage you to check out our [RATH Docs](https://kanaries.net/docs) for ref
## Community
-[RATH community](https://kanaries.net/community) is a place to have open discussions on features, voice your ideas, or get help with general questions. Get onboard with us through the following channels:
+[Kanaries community](https://kanaries.net/community) is a place to have open discussions on features, voice your ideas, or get help with general questions. Get onboard with us through the following channels:
Our developer community is the backbone of the ongoing RATH project. We sincerely welcome you to [join our community](join), participate in the conversation and stay connected with us for the latest updates. Feel free to [contribute to the RATH project](contribution-guide), submit any issues on our GitHub page, or split your grand new ideas in our chats.
From 2c57a7154dd2bfb61065c3ab5b2f6879a9192451 Mon Sep 17 00:00:00 2001
From: jojocys <270001151@qq.com>
Date: Wed, 23 Nov 2022 18:49:07 +0800
Subject: [PATCH 3/3] fix: main desc
---
README.md | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
diff --git a/README.md b/README.md
index 1674a6cc..b2b6e425 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,10 @@
-Welcome to the RATH Project
-
-
RATH
+
RATH
-
+
-
Your Open Source Augmented Analytics Alternative for Business Intelligence
+
Your Open Source Augmented Analytics Business Intelligence Solution
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+