Skip to content

Commit 2509e53

Browse files
Merge pull request #342 from Kanaries/readme-fix
doc: Update to latest information
2 parents c299d51 + 770c31c commit 2509e53

File tree

2 files changed

+35
-43
lines changed

2 files changed

+35
-43
lines changed

LICENSE2

Lines changed: 0 additions & 14 deletions
This file was deleted.

README.md

Lines changed: 35 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -41,68 +41,76 @@
4141

4242
## Introduction
4343

44-
**RATH** i an software beyond open-source alternative to Data Analysis and Visualization tools such as Tableau. It automates your Exploratory 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.
44+
**RATH** is not just an open-source alternative to Data Analysis and Visualization tools such as Tableau, but it automates your Exploratory 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.
4545

46-
<a href="https://kanaries.net"><img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-readme/feature-demo.gif" alt="RATH features demo"></a>
46+
<a href="https://kanaries.net"><img src="https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/demo.gif
47+
" alt="RATH features demo"></a>
4748

4849
## Get started
4950

5051
Get started with RATH now!
51-
- 🚀 [Online RATH / Demo](https://rath.kanaries.net)
52+
- 🚀 [Sandbox demo for parts of features](https://rath.kanaries.net)
5253
- 📖 [Read RATH Docs](https://docs.kanaries.net)
5354
- [Video introducing RATH's data painter](https://youtu.be/djqePNyhz7w)
5455

5556

56-
## Table of contents
57+
## Features
58+
+ 🤖 [AutoPilot for Data Exploration](https://docs.kanaries.net/rath/explore-data/automated-data-insight): Get Insights with One Click! Augmented analytic engine for discovering patterns, insights, and causals. A fully-automated way to explore and visualize dataset with one click.
5759

58-
[Feature highlights](#features) | [Walkthroughs](#walkthroughs) | [Developer Documentation](#developer-documentation) | [Project Status](#project-status) | [Community](#community) | [Contributions](#contributions)
60+
- 🛠 [Copilot for Data Exploration](https://docs.kanaries.net/rath/explore-data/data-exploration-copilot): RATH will work as your copilot in data science, learn your intends and generate relevant recommendations.
5961

60-
## Features
61-
+ 🤖 [Mega-auto exploration](https://docs.kanaries.net/auto-explore): Augmented analytic engine for discovering patterns, insights, and causals. A fully-automated way to explore your data set and visualize your data with one click.
62+
- Natural Language interface: Ask questions in natural language to get answers/visualizations from your data.
6263

6364
+ AutoVis: Auto-generated multi-dimensional data visualization based on the effectiveness score.
6465

65-
- 👓 [Data Wrangler](https://docs.kanaries.net/data-source): Automated data wrangler for generating summary of the data and data transformation.
66-
67-
- 🛠 [Semi-auto exploration](https://docs.kanaries.net/semi-auto-explore): Combines automated data exploration and manual exploration. RATH will work as your copilot in data science, learn your interests and uses augmented analytics engine to generate relevant recommendations for you.
66+
- 👓 [Data Wrangler](https://docs.kanaries.net/rath/prepare-data/extract-text-patterns): Automated data wrangler for generating summary of the data and data transformation.
6867

69-
- 🎨 [Data painter](https://docs.kanaries.net/data-painter): An interactive, instinctive yet powerful tool for exploratory data analysis by directly coloring your data, with further analytical features. A video about data painter [here](https://youtu.be/djqePNyhz7w)
68+
- 🎨 [Data Painter](https://docs.kanaries.net/rath/explore-data/data-painter): An interactive, instinctive yet powerful tool for exploratory data analysis by directly coloring your data, with further analytical features. Watch [this video](https://youtu.be/djqePNyhz7w) demonstrating about how to discover data insights with Data Painter.
7069

7170
- :bar_chart: Dashboard: build a beautiful interactive data dashboard (including a automated dashboard designer which can provide suggestions to your dashboard).
7271

73-
- :construction: Causal Analysis: Provide causal discovery and explanations for complex relation analysis.
72+
- Causal Analysis: Identify and examine the causal relationship between variables, which can help explore the data, create better prediction models and make business decission.
7473

7574

7675
## Walkthroughs
7776

7877
### Import data from online databases or CSV/JSON files.
7978

80-
[![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/ds-create.png)](https://docs.kanaries.net/data-profiling#import-your-data)
79+
[![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/ds-create.png)](https://docs.kanaries.net/rath/connect-your-data)
8180

8281

8382
### View statistics from your data source
8483

85-
[![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/data-profiling-readme.gif)](https://docs.kanaries.net/data-profiling#data-profiling)
84+
[![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/data-profiling-readme.gif)](https://docs.kanaries.net/rath/prepare-data/data-profiling#data-profiling-with-rath)
8685

8786
### Data Preparation
87+
8888
RATH support data preparation with black magic like predictive transformation operations. It will automatically generate suggestions of transformations and cleaning, etc.
8989

90-
[![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/text-pattern-general.gif)](https://docs.kanaries.net/data-profiling#data-profiling)
90+
[![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/text-pattern-general.gif)](https://docs.kanaries.net/rath/prepare-data/data-transformation)
9191

9292
### One-click automated data analysis with visualizations
9393

94+
Augmented analytic engine for discovering patterns, insights, and causals. A fully-automated way to explore and visualize dataset with one click.
95+
9496

95-
[![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/mega-auto.gif)](https://docs.kanaries.net/mega-auto-data-exploration)
97+
[![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/autopilot.gif)](https://docs.kanaries.net/rath/explore-data/automated-data-insight)
9698

97-
### Use RATH as your AI Copilot in Data Analysis
99+
### Use RATH as your Copilot in Data Analysis
98100

99-
Assisted with AI, RATH can help you with your data analysis. Just provide RATH with some input and it will learn about your interests and suggest analysis directions to take.
101+
RATH will work as your copilot in data science, learn your intends and generate relevant recommendations.
100102

101-
[![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/semi-auto-readme.gif)](https://docs.kanaries.net/semi-auto-data-exploration)
103+
[![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/copilot.gif)](https://docs.kanaries.net/rath/explore-data/data-exploration-copilot)
104+
105+
### Ask about your data
106+
107+
Ask questions about your data, RATH integrates with GPT to generate answers and visualizations.
108+
109+
![](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/ask-rath.gif)
102110

103111
### Manually explore your data with drag and drop:
104112

105-
<a href="https://docs.kanaries.net/semi-auto-data-exploration#manually-explore-your-data"><img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-readme/manually-explore-data-tableau-ui.gif" alt="Manually explore your data with a Tableau-like UI"></a>
113+
<a href="https://docs.kanaries.net/rath/explore-data/explore-data-graphic-walker"><img src="https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/graphic-walker.gif" alt="Manually explore your data with a Tableau-like UI"></a>
106114

107115
> Manual Exploration is an independent embedding module. You can use it independently in your apps. For more details, refer to the README.md in in `packages/graphic-walker/README.md`.
108116
>
@@ -117,7 +125,7 @@ Assisted with AI, RATH can help you with your data analysis. Just provide RATH w
117125
118126
[Data Painter Video 🔥 on Youtube](https://youtu.be/djqePNyhz7w)
119127
120-
<a href="https://docs.kanaries.net/data-painter"><img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-readme/data-analysis-paiting.gif" alt="Interactive data analysis by painting"></a>
128+
<a href="https://docs.kanaries.net/rath/explore-data/data-painter"><img src="https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/data-painter.gif" alt="Interactive data analysis by painting"></a>
121129
122130
### 🌅 Causal Analysis (Alpha stage)
123131
@@ -132,7 +140,7 @@ RATH's causal analysis feature include:
132140
133141
![Causal Analysis](https://docs-us.oss-us-west-1.aliyuncs.com/images/readme/causal-feature.png)
134142
135-
For more about Causal Analysis features, refer to [RATH Docs](https://docs.kanaries.net/causal-analysis).
143+
For more about Causal Analysis features, refer to [RATH Docs](https://docs.kanaries.net/rath/discover-causals/causal-analysis).
136144
137145
## Supported Databases
138146
@@ -153,15 +161,15 @@ RATH supports a wide range of data sources. Here are some of the major database
153161
<img src="https://kanaries-docs.oss-cn-hangzhou.aliyuncs.com/img/github-logos/airtable.png" alt="AirTable" border="0" width="200" height="80"/>
154162
</p>
155163
156-
If you want to add support for more database types or data engines, feel free to [Contact us](https://docs.kanaries.net/join#-need-help)
164+
If you want to add support for more database types or data engines, feel free to [Contact us](https://docs.kanaries.net/support)
157165
158166
## Developer Documentation
159167
160168
RATH software is in open alpha stage. We are working on improving its code and documentation.
161169
162170
If you are using RATH for your project(s), please let us know what are you using it for by emailing us at [[email protected]]([email protected]). Feedbacks are also welcomed. If you find a bug or have a feature request, please create an issue.
163171
164-
We encourage you to check out our [RATH Docs](https://docs.kanaries.net) for references and guidance. RATH Docs are scripted and maintained by technical writers and editors who collectively follow a standardized [style guide](https://docs.kanaries.net/documentation-style-guide) to produce clear and consistent documentation.
172+
We encourage you to check out our [RATH Docs](https://docs.kanaries.net) for references and guidance.
165173
166174
## Project Status
167175
@@ -191,7 +199,7 @@ Feel free to [contribute to the RATH project](contribution-guide), submit any is
191199
192200
## Contributions
193201
194-
Please check out the [Contributing to RATH guide](https://docs.kanaries.net/contribution-guide)
202+
Please check out the [Contributing to RATH guide](https://docs.kanaries.net/community/contribution-guide)
195203
for guidelines about how to proceed.
196204
197205
Thanks to all contributors :heart:
@@ -201,9 +209,7 @@ Thanks to all contributors :heart:
201209
</a>
202210
203211
## LICENSE (AGPL)
204-
Rath is an automated data analysis and visualization tool (auto-EDA).
205-
206-
See LICENSE and LICENSE2 for details.
212+
Rath is an automated data analysis and visualization tool (auto-EDA). It is a free and open-source software licensed under the AGPL.
207213
208214
---
209215
@@ -214,4 +220,4 @@ Branded icons are licensed under their copyright license.
214220
<strong>Have fun with data!</strong> ❤️
215221
</p>
216222
217-
[⬆ Back to Top](#welcome)
223+
[⬆ Back to Top](#introduction)

0 commit comments

Comments
 (0)