# primihub **Repository Path**: wellxy_admin/primihub ## Basic Information - **Project Name**: primihub - **Description**: Hyper Multi-Party computing platform，原语科技开源隐私计算平台 - **Primary Language**: C++ - **License**: Apache-2.0 - **Default Branch**: develop - **Homepage**: https://www.primihub.com - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 23 - **Created**: 2022-11-15 - **Last Updated**: 2022-11-15 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # PrimiHub ![build workflow](https://github.com/primihub/primihub/actions/workflows/main.yml/badge.svg?branch=master) [![Contributors](https://img.shields.io/github/contributors/primihub/primihub.svg)](https://github.com/linuxsuren/github-go/graphs/contributors) [![Gitter](https://badges.gitter.im/primihub/community.svg)](https://gitter.im/primihub/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![GitHub release](https://img.shields.io/github/release/primihub/primihub.svg?label=release)](https://github.com/linuxsuren/github-go/releases/latest) [![Docker Pulls](https://img.shields.io/docker/pulls/primihub/primihub-node.svg)](https://hub.docker.com/r/primihub/primihub-node/tags) > 中文 | [English](README.md) ## 特性 PrimiHub是一个支持多方计算、联邦学习、隐私求交(PSI)、隐私查询(PIR)特性的平台，支持数据源接入、数据消费、接入应用、语法、语义、安全协议多方面的扩展。 具体请见 PrimiHub [核心特性](http://docs.primihub.com/docs/category/%E6%A0%B8%E5%BF%83%E7%89%B9%E6%80%A7)。 ## 快速开始 5分钟运行起来一个MPC应用 安装 [docker](https://docs.docker.com/install/overview/) 和 [docker-compose](https://docs.docker.com/compose/install/) 下载 `docker-compose` 文件： ```shell curl https://get.primihub.com/release/1.3.9/docker-compose.yml -s -o docker-compose.yml ``` ## 运行一个MPC案例 ![Depolyment](doc/tutorial-depolyment.jpg) ### 启动节点 ***启动测试用的节点*** 使用docker-compose 启动三个docker容器。 容器包括：启动点、三个节点 ```bash docker-compose up -d ``` 或者，您也可以通过环境变量指定镜像服务地址以及版本号，例如： ```shell REGISTRY=registry.cn-beijing.aliyuncs.com TAG=1.4.0 docker-compose up -d ``` 查看运行起来的 docker 容器： ```shell docker-compose ps ``` ```shell CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES cf875c1280be primihub/primihub-node:latest "/bin/bash -c './pri…" 11 minutes ago Up 11 minutes 0.0.0.0:12120-12121->12120-12121/tcp, 0.0.0.0:8052->50050/tcp node2_primihub 6a822ff5c6f7 primihub/primihub-node:latest "/bin/bash -c './pri…" 11 minutes ago Up 11 minutes 0.0.0.0:10120->12120/tcp, 0.0.0.0:10121->12121/tcp, 0.0.0.0:8050->50050/tcp node0_primihub 11d55ce06ff0 primihub/primihub-node:latest "/bin/bash -c './pri…" 11 minutes ago Up 11 minutes 0.0.0.0:11120->12120/tcp, 0.0.0.0:11121->12121/tcp, 0.0.0.0:8051->50050/tcp node1_primihub 68befa6ab2a5 primihub/simple-bootstrap-node:1.0 "/app/simple-bootstr…" 11 minutes ago Up 11 minutes 0.0.0.0:4001->4001/tcp simple_bootstrap_node ``` ### 创建一个MPC任务 ***让三个节点共同执行一个多方安全计算（MPC）的逻辑回归任务*** ```shell docker run --network=host -it primihub/primihub-node:latest primihub-cli --server=127.0.0.1:8050 ``` > 💡 请求任务的节点 > > 你可以向计算集群中任意一个节点请求计算任务 > > 💡 可用的任务参数 > > 通过primihub-cli可以指定以下参数 > 1. 请求哪个节点启动任务 > 2. 使用哪些共享数据集 > 3. 做什么样的隐私计算任务 在这个例子中primihub-cli会使用默认参数向 ***node 0*** 请求一个ABY3的三方逻辑回归测试任务，关于cli可以指定的参数请见 ***[创建任务]([http://docs.primihub.com/docs/advance-usage/create-tasks](https://docs.primihub.com/docs/category/%E5%88%9B%E5%BB%BA%E4%BB%BB%E5%8A%A1))***。 ## 进阶使用 想了解如何从原生应用启动以及关于如何利用PrimiHub的特性，实现更多应用，见 [进阶使用](http://docs.primihub.com/docs/category/%E8%BF%9B%E9%98%B6%E4%BD%BF%E7%94%A8)。 ## 开发者 * 关于如何编译，请见[编译](http://docs.primihub.com/docs/developer-docs/build) * 关于如何贡献代码，请见 [PrimiHub开源社区治理](http://docs.primihub.com/docs/primihub-community) ## [路线图](https://docs.primihub.com/docs/roadmap/) ## 如何贡献 如果你想参与PrimiHub项目，可以在[Issue](https://github.com/primihub/primihub/issues) 页面随意开启一个新的话题，比如文档、创意、Bug等。 同时可以了解我们的社区治理结构 [PrimiHub社区治理委员会](http://docs.primihub.com/docs/primihub-community) 我们是一个开放共建的开源项目，欢迎参与到我们的项目中。 ## 贡献者 [contrib.rocks](https://contrib.rocks) ## 社区 * Slack: [primihub.slack.com](https://join.slack.com/t/primihub/shared_invite/zt-1iftyi7x0-n_HqllTgPfoEcgqw5UzoYw) * 微信助手: ![wechat_helper](./doc/wechat.jpeg)