Skip to content

Commit

Permalink
Merge pull request #169 from FederatedAI/develop-2.0.0
Browse files Browse the repository at this point in the history
Develop 2.0.0
  • Loading branch information
dylan-fan authored Dec 28, 2023
2 parents ce465d7 + fc12ccd commit 1fc1ad7
Show file tree
Hide file tree
Showing 1,087 changed files with 30,972 additions and 168,799 deletions.
16 changes: 1 addition & 15 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,10 @@ FATEBoard是联邦学习建模的可视化工具,旨在帮助用户简单而

# **使用** #

**数据库配置**

集群版本FATEBoard默认的数据库是mysql,如果你使用单机版FATEBoard,那么你需要用sqlite数据库。只要用sqlite参数更新这个文件:FATEBoard/src/main/resources/application.properties。你需要更新的参数如下:
spring.datasource.driver-Class-Name=org.sqlite.JDBC

fateboard.datasource.jdbc-url=xxx

fateboard.datasource.username=

fateboard.datasource.password=


**启动FATEBoard**

FATEBoard代码使用spring-boot框架并嵌入在tomcat容器中,默认的网络端口是8080。在启动前,需要检查机器的8080端口是否被占用,如果端口被占用,FATEBoard将会启动失败。

FATEBoard通过访问mysql数据库来获得任务列表,如果没有正确安装数据库,那么任务获取就会失败。

FATEBoard通过HTTP协议来访问FATEFlow。如果没有正常启动FATEFlow,FATEBoard将无法呈现任务图表。

你可以通过 http://{FATEBoard-ip}:8080来访问FATEBoard。
Expand Down Expand Up @@ -89,6 +75,6 @@ FATEBoard通过给FATE-Flow发送Http请求获得每个算法模块的输出数

**FATEBoard没有显示算法模块运行日志**

FATEBoard通过查询数据库展示所有的算法任务以及他们的详细信息
FATEBoard通过查询FATEFLOW展示所有的算法任务以及他们的详细信息
在单机版中,FATEBoard查询本地日志文件,并通过websocket协议在前端展示。所以如果日志无法显示,请确认日志文件是否正常生成。
在集群版中,FATEBoard通过ssh方式读取不同机器上的日志文件,通过websocket协议推送到前端。默认的日志路径是/data/projects/fate/logs。如果日志无法展示,那么可能是ssh的连接信息错误,你可以点击页面右上角的设置按钮重新设置正确的ssh连接信息。
15 changes: 1 addition & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,10 @@ As a built-in visualization tool for FATE, FATEBoard presents abundant data visu

# **Usage** #

**Database Configuration**

The default database for FATEBoard for cluster version is mysql. If you want to use standalone version, you should use sqlite databse. Just update the file : FATEBoard/src/main/resources/application.properties with right parameters of sqlite. The parameters you should update are below:

spring.datasource.driver-Class-Name=org.sqlite.JDBC

fateboard.datasource.jdbc-url=xxx

fateboard.datasource.username=

fateboard.datasource.password=

**Starting FATEBoard**

The FATEBoard source code uses the spring-boot framework and the embedded tomcat container. The default web port provided is 8080. Before starting, it is necessary to check whether port 8080 of the machine is already occupied. If the port is occupied, FATEBoard will fail to start.

FATEBoard gets job list through accessing MySQL database. If the database is not installed properly, the job list query will fail.
FATEBoard access FATE-Flow through HTTP protocol. If FATE-Flow is not started properly, FATEBoard will not display charts.

You can access FATEBoard by visiting http://{fateboard-ip}:8080.
Expand Down Expand Up @@ -89,6 +76,6 @@ FATEBoard sends a request to access FATE-Flow via HTTP to obtain all the data ne

**My FATEBoard isn’t showing any log!**

FATEBoard gets the list of jobs and details by querying MySQL.
FATEBoard gets the list of jobs and details by querying fateflow.
In a stand-alone environment, FATEBoard reads the local log file and returns it to the user through WebSocekt. If the log file cannot be displayed, you can first check whether the local log file has been generated.
In a clustered environment, FATEBoard could access log files on different machines with SSH, and push them to the browser through WebSocket. The default log lookup path is /data/projects/fate/logs. If you cannot view the logs, it may be an error in SSH information in the cluster. you can set the correct SSH information by clicking the button in the upper right corner of the page.
10 changes: 10 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
# Release 2.0.0

#### Major Features and Improvements
**Major Features**

* Refactoring DAG components, adding support for stage status, and displaying dynamic ports.
* Update the cache structure to optimize issues such as user timeout handling and duplicate storage of configuration information.
* Optimize some interactive functions.
* Update the style theme.

# Release 1.11.2

#### Major Features and Improvements
Expand Down
Loading

0 comments on commit 1fc1ad7

Please sign in to comment.