Poincaré Embedding 项目启动与配置教程

1. 项目的目录结构及介绍

Poincaré Embedding 项目目录结构如下：

poincare-embedding/
├── include/                # 包含项目所需的头文件
├── misc/                   # 包含一些杂项文件
├── scripts/                # 包含脚本文件，用于生成数据等
├── src/                    # 源代码目录，包含C++实现
├── .gitignore              # 指定git忽略的文件列表
├── CMakeLists.txt          # CMake构建文件
├── LICENSE                 # 项目许可证文件
├── README.md               # 项目说明文件
├── requirements.txt        # Python环境依赖文件

• include/：存放项目所需的C++头文件。
• misc/：包含项目的杂项文件，例如辅助脚本或临时文件。
• scripts/：包含用于创建数据集的Python脚本。
• src/：存放项目的C++源代码。
• .gitignore：定义了Git应该忽略的文件和目录。
• CMakeLists.txt：CMake构建系统文件，用于编译C++代码。
• LICENSE：项目使用的MIT许可证文件。
• README.md：项目的Markdown格式说明文件，包含了项目的简介、安装和使用说明。
• requirements.txt：Python环境的依赖文件，列出了项目所需的Python包。

2. 项目的启动文件介绍

项目的启动主要是通过CMake来构建C++环境，具体步骤如下：

1. 克隆项目到本地：

   git clone https://github.com/TatsuyaShirakawa/poincare-embedding.git
   

2. 创建构建目录并进入：

   cd poincare-embedding
   mkdir work
   cd work
   

3. 运行CMake来配置项目：

   cmake ..
   

4. 编译项目：

   make
   

完成以上步骤后，就可以编译得到项目的可执行文件。

3. 项目的配置文件介绍

项目的配置主要是通过requirements.txt文件和命令行参数进行。

• requirements.txt：该文件列出了项目所需的Python包，可以使用以下命令安装：

  python3 -m pip install -r requirements.txt
  

• 命令行参数：在运行Poincaré Embedding的可执行文件时，可以传入多个参数来配置训练过程，例如：

  ./poincare_embedding ./mammal_subtree.tsv ./embeddings.tsv -d 2 -t 8 -e 1000 -l 0.1 -L 0.0001 -n 20 -s 0
  

  其中，-d指定了嵌入向量的维度，-t指定了树的深度，-e指定了训练的迭代次数，-l指定了学习率，-L指定了L2正则化项的系数，-n指定了每个批次处理的节点数量，-s指定了随机种子。

以上就是Poincaré Embedding项目的启动与配置教程。