快速安装指南#

在使用PySyft之前，您需要先安装它。文档提供了完整的部署指南，涵盖了在服务器和生产环境中安装和部署PySyft的所有可能性。

本节将引导您完成一个最小化安装确保可用，以便您顺利学习入门指南和教程。

安装Python#

Python是PySyft中的一等公民。因此，您需要在计算机上安装Python才能使用PySyft。

PySyft 需要 Python 3.10 或更高版本，这意味着任何 Python 3.9 及更新的版本都与 PySyft 兼容。请通过 Python 官网或您操作系统的包管理器获取最新版本的 Python。

你可以通过在终端输入python来验证是否已安装Python；你应该会看到类似以下内容：

Python 3.x.y
[GCC 4.x] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>>

安装 PySyft#

PySyft 软件包拥有一系列依赖项，旨在提供一个开箱即用的数据科学环境。因此，在安装 PySyft 之前，强烈建议创建一个 Python 虚拟环境，以便将 PySyft 安装与您可能已有的其他库或数据科学环境隔离开来。

创建虚拟环境#

在Python中创建虚拟环境有多种方法，您当前使用的任何管理虚拟环境的方式同样有效且适用。

在本指南中，我们将展示如何使用Python标准库内置的venv模块快速创建新的Python虚拟环境。每个虚拟环境都将拥有独立的Python包集合，这些包会安装在其各自的站点目录中。

已安装的Python环境

该模块支持创建轻量级的"虚拟环境"，即在现有Python安装基础上创建的虚拟环境。换句话说，您需要先在计算机上安装Python版本才能创建此虚拟环境。

要创建一个新环境，需要执行命令 venv：

$ python -m venv /path/to/new/virtual/environment

注意

命令中的$符号只是一个占位符，用于表示Linux/Unix操作系统中的通用终端提示符。

Windows用户

如果您使用的是Windows系统，上述命令将无法运行。在Windows PowerShell中，等效的相同命令应为：

PS > python -m venv \path\to\new\virtual\environment\

这将创建一个新文件夹，用于存放虚拟环境。 要开始使用新的虚拟环境，需要先激活它。我们可以通过执行安装时附带的shell脚本来激活新环境。

$ source /path/to/new/virtual/environment/bin/activate

一旦激活，当前shell中的提示符会发生变化，包含您环境的名称。

Windows用户：

PS > \path\to\new\virtual\environment\Scripts\activate

一旦激活，我们就可以顺利进行PySyft的安装。

安装PySyft#

安装PySyft非常简单，可以通过pip进行安装：

$ pip install syft

这将下载syft包及其所有依赖项。

验证安装#

要验证PySyft是否已正确安装，并且可以在Python包的路径中找到，请在您的shell中输入python。

检查虚拟环境

请确保您仍在使用之前激活的虚拟环境，其中已安装PySyft。

然后，在Python提示符下，尝试导入PySyft：

>>> import syft as sy
>>> print(sy.__version__)
0.9

更新现有(旧版)PySyft#

如果您安装了旧版本的PySyft，可以通过运行以下命令将其更新至最新版本：

$ pip install --upgrade syft

不过，为了确保所有功能都能正常运作，我们始终建议按照上述说明在专用的Python虚拟环境中全新安装PySyft。

代码符号快速说明#

你可能已经注意到，在前面的导入语句中，当我们导入syft时，使用了一个别名（即Python关键字as）。

这是因为在Python的通用编码实践中，习惯使用别名来缩短包名，以便在整个代码中使用。这种做法如今已成为导入某些包时的事实标准，使得任何人在阅读代码时都能立即明白我们指的是哪个包。

例如NumPy或Pandas就是这种情况：

import numpy as np
import pandas as pd

我们将在整个文档中使用这种表示法，用sy作为syft的缩写。

On this page