1 Star 0 Fork 0

WeBankOpenSource / FATE-Board

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

DOC|English

FATEBoard是联邦学习建模的可视化工具,旨在帮助用户简单而高效地理解模型与探索模型。

为了便于理解、跟踪、调试和探索联邦学习建模过程,以及检查、评估和对比各种联邦学习模型。FATEBoard提供一种可视化的方式来探查模型,从而你可以更有效地调试和改善模型效果。

作为FATE内置的可视化工具,FATEBoard展示了丰富的数据可视化和模型可视化信息。在Running管理中,你可以监控所有进程中的job。在Dashboard,你可以实时跟踪算法组件运行的全过程,并跟踪日志详情。FATEBoard提供任务的管理,在job管理中,可以获得模型参数、模型运行结果,包括模型输出结果、模型数据结果、输出日志等。

使用

启动FATEBoard

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

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

你可以通过 http://{FATEBoard-ip}:8080来访问FATEBoard。

启动一个新的建模任务

1.准备条件:配置一个pipeline,创建DAG图,定义参数。 2.启动FATEBoard:提交并启动任务后,返回一个任务URL,点击URL即可在网页上访问这个任务。或者,在任务启动时,你可以通过web浏览器访问http://{FATEBoard-ip}:8080来查看FATEBoard。 host或arbiter方也可以通过http://{FATEBoard-ip}:8080访问FATEBoard。 3.监控任务:dashboard可视化了任务运行全过程。 4.查看任务:可视化查看每个算法组件的模型输出、数据输出、运行日志等。

FATEBoard适用的浏览器包括Google浏览器、IE 10.0及以上和其他主流浏览器。另外一些浏览器可能也可以,但不排除存在bug或性能问题。

可视化

任务仪表盘

FATEBoard的任务仪表盘展示了任务运行过程中随时间变化,包括任务运行时间、实时更新日志、每个组件的运行状态。当你提交任务,你可能需要等待任务开始运行,此时可以查看running页面查看所有运行中的任务及等待运行的任务。

任务可视化

任务可视化提供了任务执行的全览,尽可能地可视化任务的结果。一些交互说明如下:

  • 页面左侧展示了任务的基本信息
  • 点击组件,可以查看组件参数
  • 点击组件参数下方的按钮,可以查看组件的输出。通过切换标签查看模型输出、模型汇总,模型指标、数据输出和日志等

工作流的可视化

联邦学习建模的工作流可以帮助你更加直观地跟踪运行中的任务,对于每一方参与建模的角色,都可以查看各自在联邦建模中的图表。

模型图表可视化

FATEBoard给联邦学习模型提供了丰富多样的可视化方式,包括统计表、直方图、曲线等等。你可以对比同一数据集使用不同训练模型训练的效果,或者探查一个模型的性能,从而不断地调试和训练,以上都可以很好地帮助你找到最佳的模型。

数据的可视化

每个组件的数据输出可以预览100行原始数据和预测数据,预测数据包括预测结果、预测分数和预测详细信息。

常见问题

FATEBoard没有显示任何组件的数据

FATEBoard通过给FATE-Flow发送Http请求获得每个算法模块的输出数据。而源码中的logback.xml文件指定了该请求的日志输出,根据该日志你能轻松定位到定位2个服务之间的通讯问题,找到获取数据失败的原因。

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

FATEBoard通过查询FATEFLOW展示所有的算法任务以及他们的详细信息。 在单机版中,FATEBoard查询本地日志文件,并通过websocket协议在前端展示。所以如果日志无法显示,请确认日志文件是否正常生成。 在集群版中,FATEBoard通过ssh方式读取不同机器上的日志文件,通过websocket协议推送到前端。默认的日志路径是/data/projects/fate/logs。如果日志无法展示,那么可能是ssh的连接信息错误,你可以点击页面右上角的设置按钮重新设置正确的ssh连接信息。

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

FATE-Board 展开 收起
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/WeBankOS/FATE-Board.git
git@gitee.com:WeBankOS/FATE-Board.git
WeBankOS
FATE-Board
FATE-Board
master

搜索帮助