PrimiHub 开源项目使用教程
1. 项目的目录结构及介绍
PrimiHub 项目的目录结构如下:
primihub/
├── docs/
├── example/
├── src/
├── tests/
├── docker-compose.yml
├── LICENSE
├── README.md
└── ...
docs/
: 包含项目的文档文件。example/
: 包含示例配置文件和示例代码。src/
: 项目的源代码。tests/
: 测试代码。docker-compose.yml
: Docker 部署配置文件。LICENSE
: 项目许可证。README.md
: 项目介绍和使用说明。
2. 项目的启动文件介绍
PrimiHub 项目的启动文件主要是通过 Docker 进行部署。以下是启动步骤:
-
下载项目代码:
git clone https://github.com/primihub/primihub.git
-
启动容器:
cd primihub && docker-compose up -d
-
进入容器:
docker exec -it primihub-node0 bash
-
执行隐私求交计算:
/primihub-cli --task_config_file="example/psi_ecdh_task_conf.json"
3. 项目的配置文件介绍
PrimiHub 项目的配置文件主要位于 example/
目录下,例如 psi_ecdh_task_conf.json
。以下是一个示例配置文件的内容:
{
"task_name": "psi_ecdh",
"input_datasets": [
{
"dataset_id": "dataset1",
"data_path": "data/input/dataset1.csv"
},
{
"dataset_id": "dataset2",
"data_path": "data/input/dataset2.csv"
}
],
"output_path": "data/result/psi_result.csv"
}
task_name
: 任务名称。input_datasets
: 输入数据集的配置,包括数据集ID和数据路径。output_path
: 输出结果的路径。
以上是 PrimiHub 开源项目的基本使用教程,涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。