Skip to content

Commit

Permalink
modify doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tugraph committed Jun 6, 2023
2 parents acee8e4 + 6332cf6 commit 6550301
Show file tree
Hide file tree
Showing 104 changed files with 465 additions and 496 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,13 @@ Slack (For developer quick communication):

DingTalk Group (For general technical discussion)

![alert](./doc/doc_images/dingtalk.png)
![alert](./doc/images/dingtalk.png)

WeChat Group (For general technical discussion)

![alert](./doc/doc_images/wechat_tech.png)
![alert](./doc/images/wechat_tech.png)

WeChat Official Account (For announcement)

![alert](./doc/doc_images/wechat.png)
![alert](./doc/images/wechat.png)

6 changes: 3 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,13 +68,13 @@ Slack (在线开发沟通):

钉钉群 (技术交流)

![alert](./doc/doc_images/dingtalk.png)
![alert](./doc/images/dingtalk.png)

微信群 (技术交流)

![alert](./doc/doc_images/wechat_tech.png)
![alert](./doc/images/wechat_tech.png)

微信公众号 (信息发布)

![alert](./doc/doc_images/wechat.png)
![alert](./doc/images/wechat.png)

6 changes: 3 additions & 3 deletions ci/github_ci.sh
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ cd $WORKSPACE/build/output
OMP_NUM_THREADS=8 ./unit_test --gtest_output=xml:$WORKSPACE/testresult/gtest/
rm -rf testdb* .import_tmp

cd $WORKSPACE/src/client/python/TuGraphClient
#cd $WORKSPACE/src/client/python/TuGraphClient
# install TuGraphClient
python3 setup.py install
#python3 setup.py install
# run TuGraphClient unit_tests
python3 setup.py test
#python3 setup.py test

# integrate tests
cd $WORKSPACE/build/output
Expand Down
2 changes: 1 addition & 1 deletion deps/tiny-process-library
Binary file removed doc/doc_images/cloud-deployment-8.png
Binary file not shown.
Binary file removed doc/doc_images/cloud-deployment-9.png
Binary file not shown.
Binary file removed doc/doc_images/three-body-cypher1.png
Binary file not shown.
Binary file removed doc/doc_images/three-body-cypher2.png
Binary file not shown.
Binary file removed doc/doc_images/three-body-data.png
Binary file not shown.
Binary file removed doc/doc_images/three-kingdoms-cypher1.png
Binary file not shown.
Binary file removed doc/doc_images/three-kingdoms-cypher2.png
Binary file not shown.
Binary file removed doc/doc_images/three-kingdoms-cypher3.png
Binary file not shown.
Binary file removed doc/doc_images/three-kingdoms-cypher4.png
Binary file not shown.
Binary file removed doc/doc_images/three-kingdoms-cypher5.png
Binary file not shown.
Binary file removed doc/doc_images/wandering-earth-1.png
Binary file not shown.
Binary file removed doc/doc_images/wandering-earth-2.png
Binary file not shown.
Binary file removed doc/doc_images/wandering-earth-3.png
Binary file not shown.
1 change: 0 additions & 1 deletion doc/en-US/images

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Interfaces can be roughly divided into client interfaces and server interfaces.

The server interfaces are all at the calculation layer and are logically separated from the graph data storage by a Core API layer.

![Multi Level Interfaces](../../../../doc_images/multi-level-Interfaces-en.png)
![Multi Level Interfaces](../../../../images/multi-level-Interfaces-en.png)

### 1.1.Client Interface

Expand All @@ -30,4 +30,4 @@ The server interface includes Cypher, Procedure API, OLAP API, and GNN PI, which
> __GNN API__ mainly provides the interfaces needed for graph neural network applications and can be integrated with machine learning frameworks such as PyTorch. TuGraph's GNN PI mainly integrates DGL and completes the entire process from graph storage to graph neural network application in the Python language environment.
Except for Cypher's interpretive execution, all other server interfaces are compiled and executed, meaning that the corresponding code needs to be sent to the server and compiled (which may take some time) before execution on the server. Therefore, it is usually necessary to load the program first, then find it in the list of loaded applications, and execute it after passing in the input parameters.
Except for Cypher's interpretive execution, all other server interfaces are compiled and executed, meaning that the corresponding code needs to be sent to the server and compiled (which may take some time) before execution on the server. Therefore, it is usually necessary to load the program first, then find it in the list of loaded applications, and execute it after passing in the input parameters.
4 changes: 2 additions & 2 deletions doc/en-US/source/2.introduction/4.charactristics/3.htap.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
## 1.Introduction

![htap](../../../../doc_images/htap-en.png)
![htap](../../../../images/htap-en.png)

There are different ways to implement HTAP in architecture: one is to use two different copies to handle OLTP and OLAP tasks separately, with the core being data consistency synchronization and additional resource overhead; the other is to use the same data storage at all times, but this implementation has memory bloat in its data structure and needs further work for industrialization. In TuGraph's design, simple OLAP and OLTP operations share the same data, while complex OLAP operations are exported and handled separately as snapshots.

Expand Down Expand Up @@ -33,4 +33,4 @@ Corresponding to the calculation interface and storage, there are four operating
- Embed mode, which has the same interface as Plugin mode but the graph database service does not need to be started and can directly call the data in the database through the interface. This mode is usually used for debugging Procedure API and OLAP API code, and the debugging information and operation steps are more friendly than Plugin mode.
- Standalone mode, which maximally separates from the graph database, is more direct when only using the graph analysis engine for data analysis. Standalone mode will directly use the data of the external storage.

The use of the graph neural network engine is similar to the 'complex graph analysis operation', which calls part of the OLAP API and GNN API at the same time, which is not elaborated here.
The use of the graph neural network engine is similar to the 'complex graph analysis operation', which calls part of the OLAP API and GNN API at the same time, which is not elaborated here.
4 changes: 2 additions & 2 deletions doc/en-US/source/2.introduction/6.functionality.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ Ecological tools are a crucial component of enterprise-level databases, and a ri

### 6.1.TuGraph DataX

![导入导出](../../images/tugraph-datax.png)
![导入导出](../../../images/tugraph-datax.png)

TuGraph's core supports importing and exporting CSV and JSON data, offering both full database and incremental importing modes. In practice, there may be a need to import from multiple data sources such as MySQL, Kafka, and Hive, and TuGraph connects to these sources using DataX. Due to the differences between relational and graph models, data cleaning processes can be quickly processed using SparkSQL. TuGraph focuses only on the reliability and performance of simple CSV and JSON scenario imports.

Expand All @@ -98,4 +98,4 @@ TuGraph Explorer targets graph business users and focuses more on business logic

TuGraph uses the Prometheus + Grafana monitoring framework in a loosely coupled manner. Prometheus obtains monitoring information from TuGraph's monitoring interface, stores it in a local time-series database, and then displays it interactively on the web using Grafana.

The monitoring states provided by TuGraph include the state of the graph database and the state of the server. The former includes the database-side status such as read/write load and number of vertices/edges, while the latter includes the real-time status of the server's memory, CPU, and hard disk. If some monitoring state exceeds the expected threshold, proactive alerts are necessary, usually requiring integration with other operations and control systems such as group messaging and email alerts.
The monitoring states provided by TuGraph include the state of the graph database and the state of the server. The former includes the database-side status such as read/write load and number of vertices/edges, while the latter includes the real-time status of the server's memory, CPU, and hard disk. If some monitoring state exceeds the expected threshold, proactive alerts are necessary, usually requiring integration with other operations and control systems such as group messaging and email alerts.
24 changes: 12 additions & 12 deletions doc/en-US/source/4.user-guide/1.tugraph-browser.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For first-time users of TuGraph, you can quickly build a graph project with the

#### 2.3.1.Creating a Graph Project

In the `Graph Management` homepage tab, click `Create New Graph Project` to create a new graph project.
In the `Graph Project` homepage tab, click `Create New Graph Project` to create a new graph project.

![quickstart-creategraph](../../../images/browser/quickstart-creategraph.png)

Expand All @@ -44,7 +44,7 @@ In the Fill in Configurations interface, enter the graph project information. Si

#### 2.3.2.Starting a Graph Project

After creating a graph project with demo data, you can find the corresponding graph project in the `Graph Management` tab, and then click `Graph Query` to query graph data.
After creating a graph project with demo data, you can find the corresponding graph project in the `Graph Project` tab, and then click `Graph Query` to query graph data.

![quickstart-graphtab](../../../images/browser/quickstart-graphtab.png)

Expand All @@ -54,19 +54,19 @@ Execute the default query statement to browse the graph data in the demo.

For more quick start documents, please visit the[Quick Start Documents](../3.quick-start/1.preparation.md)

### 2.4.Graph Management
### 2.4.Graph Project

`Graph Management` provides visualized graph project management and graph data development functions, providing users with a series of convenient graph data visualization operations, including graph project creation, modification, deletion, and other management operations, as well as graph data queries, vertex-edge statistics, and other operations. In addition, it also supports graph model management, making it more convenient for users to manage and maintain graph data.
`Graph Project` provides visualized graph project management and graph data development functions, providing users with a series of convenient graph data visualization operations, including graph project creation, modification, deletion, and other management operations, as well as graph data queries, vertex-edge statistics, and other operations. In addition, it also supports graph model management, making it more convenient for users to manage and maintain graph data.

#### 2.4.1.Graph Project Management

On the `Graph Management` page, you can see the graph projects in the current graph database.
On the `Graph Project` page, you can see the graph projects in the current graph database.

![graphmanagement-homepage](../../../images/browser/graphmanagement-homepage.png)

##### 2.4.1.1.Creating a Graph Project

On the `Graph Management` page, click the `Create New Graph Project` button to create a new graph project.
On the `Graph Project` page, click the `Create New Graph Project` button to create a new graph project.

![graphmanagement-creategraph](../../../images/browser/graphmanagement-creategraph.png)

Expand All @@ -85,11 +85,11 @@ Creating a new graph project requires completing the creation of the graph proje

![graphmanagement-configure](../../../images/browser/graphmanagement-configure.png)

After creation, the graph project can be viewed in the graph project tab on the `Graph Management` page.
After creation, the graph project can be viewed in the graph project tab on the `Graph Project` page.

##### 2.4.1.2.Editing a Graph Project

On the `Graph Management` page, click the `Edit button` (pencil icon) in the graph project tab to edit the basic information of the corresponding graph project.
On the `Graph Project` page, click the `Edit button` (pencil icon) in the graph project tab to edit the basic information of the corresponding graph project.

![graphmanagement-editgraph-button](../../../images/browser/graphmanagement-editgraph-button.png)

Expand All @@ -99,15 +99,15 @@ graphmanagement-editgraph-button

##### 2.4.1.3.Deleting a Graph Project

On the `Graph Management` page, click the `Delete` button (trash can icon) in the graph project tab to delete the corresponding graph project.
On the `Graph Project` page, click the `Delete` button (trash can icon) in the graph project tab to delete the corresponding graph project.

![graphmanagement-deletegraph-button](../../../images/browser/graphmanagement-deletegraph-button.png)

_Note: Graph projects cannot be restored after deletion._

##### 2.4.1.4.Vertex-Edge Statistics

On the `Graph Management` page, click the `Vertex-Edge Statistics` button (line graph icon or refresh icon) in the graph project tab to count the number of vertexs and edges in the corresponding graph project.
On the `Graph Project` page, click the `Vertex-Edge Statistics` button (line graph icon or refresh icon) in the graph project tab to count the number of vertexs and edges in the corresponding graph project.

![graphmanagement-statistics-button](../../../images/browser/graphmanagement-statistics-button.png)

Expand All @@ -119,7 +119,7 @@ The statistical results will be displayed on the graph project tab. Graph projec

#### 2.4.2.Graph Building

The `Graph Building` function in Browser is mainly used for graph project model definition and data import. On the `Graph Management` page, click the `Graph Building` button in the graph project tab.
The `Graph Building` function in Browser is mainly used for graph project model definition and data import. On the `Graph Project` page, click the `Graph Building` button in the graph project tab.

![graphbuild-button](../../../images/browser/graphbuild-button.png)

Expand Down Expand Up @@ -268,7 +268,7 @@ After the file is successfully uploaded, you can click the `Continue Import` but

#### 2.4.3.Graph Query

Click the `Graph Query` button in the `graph project tab` on the `Graph Management` page to query and access graph data in the graph project. The product provides multiple modes for querying graph data, such as Statement Query, Path Query, and Vertex Query, and supports switching between graph projects and query result display.
Click the `Graph Query` button in the `graph project tab` on the `Graph Project` page to query and access graph data in the graph project. The product provides multiple modes for querying graph data, such as Statement Query, Path Query, and Vertex Query, and supports switching between graph projects and query result display.

![query-button](../../../images/browser/query-button.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Before starting to use, you need an Alibaba Cloud account to access and create r
|AliyunComputeNestUserFullAccess|Permissions for managing ComputeNest services (ComputeNest) on the user side|
|AliyunCloudMonitorFullAccess|Permissions for managing Alibaba Cloud Monitor (CloudMonitor)|

![同意授权并创建关联角色](../../../../images/cloud-deployment-1.png)
![Cloud Deployment](../../../../images/cloud-deployment-1.png)

### 3.2.Deployment Entrance

Expand Down Expand Up @@ -75,44 +75,44 @@ The creation of the service is carried out according to the following steps, ref
- Create an instance name, such as "test" in the figure below
- Select the region, such as "China East 1 (Hangzhou)" in the figure below

![Create Instance](../../../images/cloud-deployment-3.png)
![Create Instance](../../../../images/cloud-deployment-3.png)

- Select the deployment area, such as "Availability Zone I" in the figure below
- Select the instance type, currently supports ecs.r6.xlarge and ecs.r7a.xlarge specifications. If there is no model available in the list, try selecting other deployment areas.
- Select the model
- Configure the password for the instance

![Select Region](../../../images/cloud-deployment-4.png)
![Select Region](../../../../images/cloud-deployment-4.png)

- Click next to enter the order confirmation page
- Check the checkboxes for "Permission Confirmation" and "Service Terms"
- Click the green "Start Free Trial" button in the lower left corner to create a service instance

![Confirmation](../../../images/cloud-deployment-5.png)
![Confirmation](../../../../images/cloud-deployment-5.png)

### 3.5.Start TuGraph Service

- View the service instance: After the service instance is created successfully, it takes about 2 minutes for deployment. After the deployment is complete, you can see the corresponding service instance on the page, as shown in the figure below.

![View Instance](../../../images/cloud-deployment-6.png)
![View Instance](../../../../images/cloud-deployment-6.png)

- Click the service instance to access TuGraph. After entering the corresponding service instance, you can get 3 ways to use it on the page: web, rpc, ssh.

![Access Method](../../../images/cloud-deployment-7.png)
![Access Method](../../../../images/cloud-deployment-7.png)

- Click the link of web to jump to the deployed TuGraph Web. It is recommended that novice users first use the demo to quickly get started with TuGraph.
- First, on the TuGraph Web login page, enter the default username (admin) and default password (73@TuGraph) to log in, as shown in the figure below.
- After the login is completed, click "New Instance" -> "Create Instance" in sequence, wait for the creation to be completed, and the steps in 3 will change to green in turn, and it will automatically switch to the subgraph MovieDemo1, as shown in the figure below.

![Login](../../../images/cloud-deployment-8.png)
![Create Demo](../../../images/cloud-deployment-9.png)
![Login](../../../../images/cloud-deployment-8.png)
![Create Demo](../../../../images/cloud-deployment-9.png)

## 4.Common FAQs

### No available resources in the selected deployment area

Sometimes, the selected deployment area (such as Availability Zone G) does not have available resources for the selected package, and an error will be reported as shown in the figure below.

![Deployment Error](/doc/images/cloud-deployment-10.png)
![Deployment Error](../../../../images/cloud-deployment-10.png)

__Solution__:Try selecting other regions, such as Availability Zone I
__Solution__:Try selecting other regions, such as Availability Zone I
8 changes: 4 additions & 4 deletions doc/en-US/source/9.contacts.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Slack:

Dingtalk Group Chat (Discussions):

![alert](../images/dingtalk.png)
![alert](../../images/dingtalk.png)

WeChat Group Chat (Discussions):

![alert](../images/wechat_tech.png)
![alert](../../images/wechat_tech.png)

Official Accounts (Information Release):

![alert](../images/wechat.png)
![alert](../../images/wechat.png)

Email(Enterprise version consultation): tugraph@service.alipay.com
Email(Enterprise version consultation): tugraph@service.alipay.com
31 changes: 31 additions & 0 deletions doc/en-US/source/conf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'TuGraph'
copyright = '2023, Ant Group'
author = 'Ant Group'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = ['myst_parser',
'sphinx_panels',
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx.ext.viewcode']

templates_path = ['../../_templates']
exclude_patterns = []



# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = 'sphinx_rtd_theme'
html_static_path = ['../../_static']
File renamed without changes
File renamed without changes
Binary file modified doc/images/browser/account-add-button.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/browser/graphbuild-addedge.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/browser/graphbuild-editedge.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/browser/graphbuild.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/browser/graphmanagement-creategraph.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/browser/pathquery-result.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/browser/pathquery-select.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/browser/query-view.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/browser/quickstart-creategraph.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/browser/role-add-button.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified doc/images/browser/vertexquery-criteria.png
Binary file modified doc/images/browser/vertexquery.png
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added doc/images/cloud-deployment-8.png
Binary file added doc/images/cloud-deployment-9.png
File renamed without changes
Binary file added doc/images/htap-en.png
File renamed without changes
Binary file added doc/images/multi-level-Interfaces-en.png
File renamed without changes
Binary file added doc/images/three-body-cypher1.png
Binary file added doc/images/three-body-cypher2.png
Binary file added doc/images/three-body-cypher3.png
Binary file added doc/images/three-body-data.png
Binary file added doc/images/three-kingdoms-cypher1.png
Binary file added doc/images/three-kingdoms-cypher2.png
Binary file added doc/images/three-kingdoms-cypher3.png
Binary file added doc/images/three-kingdoms-cypher4.png
Binary file added doc/images/three-kingdoms-cypher5.png
File renamed without changes
File renamed without changes
Binary file added doc/images/wandering-earth-1.png
Binary file added doc/images/wandering-earth-2.png
Binary file added doc/images/wandering-earth-3.png
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
1 change: 0 additions & 1 deletion doc/zh-CN/images

This file was deleted.

0 comments on commit 6550301

Please sign in to comment.