Metadata-Version: 2.1
Name: secretflow
Version: 1.0.0b3
Summary: SecretFlow
Home-page: https://github.com/secretflow/secretflow
Author: SCI Center
Author-email: secretflow-contact@service.alipay.com
License: Apache 2.0
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: clean-text
Requires-Dist: click
Requires-Dist: grpcio (<=1.49.1)
Requires-Dist: jax (<=0.4.12)
Requires-Dist: jaxlib (<=0.4.12)
Requires-Dist: kuscia (==0.0.1b2)
Requires-Dist: multiprocess
Requires-Dist: networkx (==2.8.8)
Requires-Dist: numba (==0.57.0)
Requires-Dist: numpy (==1.23.5)
Requires-Dist: pandas (==1.5.3)
Requires-Dist: protobuf (==3.19.6)
Requires-Dist: pyarrow (==11.0.0)
Requires-Dist: s3fs (==2022.1.0)
Requires-Dist: scikit-learn (==1.1.3)
Requires-Dist: secretflow-rayfed (==0.1.1a4)
Requires-Dist: setuptools (>=65.5.1)
Requires-Dist: sparse (>=0.14.0)
Requires-Dist: spu (==0.4.1b1)
Requires-Dist: sf-heu (==0.4.4b0)
Requires-Dist: tf2onnx (>=1.13.0)
Requires-Dist: tqdm
Requires-Dist: validator.py (==1.3.0)
Requires-Dist: xgboost (==1.7.5)
Requires-Dist: wheel (>=0.38.1)
Requires-Dist: torch (==2.0.0)
Requires-Dist: torchmetrics (==0.11.4)
Requires-Dist: torchvision (==0.15.1)
Requires-Dist: torchaudio (==2.0.1)
Requires-Dist: tensorflow (==2.11.1) ; platform_machine != "arm64"
Requires-Dist: tensorflow-macos (==2.11.0) ; platform_machine == "arm64" and platform_system == "Darwin"
Requires-Dist: sdc-apis (==0.1.0b0) ; platform_system != "Darwin"
Requires-Dist: sdc-sdk (==0.1.0b0) ; platform_system != "Darwin"
Provides-Extra: dev
Requires-Dist: pylint ; extra == 'dev'

<div align="center">
    <img src="docs/_static/logo-light.png">
</div>

---

[![CircleCI](https://dl.circleci.com/status-badge/img/gh/secretflow/secretflow/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/secretflow/secretflow/tree/main)

<p align="center">
<a href="./README.zh-CN.md">简体中文</a>｜<a href="./README.md">English</a>
</p>

SecretFlow is a unified framework for privacy-preserving data intelligence and machine learning. To achieve this goal,
it provides:

- An abstract device layer consists of plain devices and secret devices which encapsulate various cryptographic protocols.
- A device flow layer modeling higher algorithms as device object flow and DAG.
- An algorithm layer to do data analysis and machine learning with horizontal or vertical partitioned data.
- A workflow layer that seamlessly integrates data processing, model training, and hyperparameter tuning.

<div align="center">
    <img src="docs/_static/secretflow_arch.svg">
</div>

## Documentation

- [SecretFlow](https://www.secretflow.org.cn/docs/secretflow/en/)
  - [Getting Started](https://www.secretflow.org.cn/docs/secretflow/en/getting_started/index.html)
  - [User Guide](https://www.secretflow.org.cn/docs/secretflow/en/user_guide/index.html)
  - [API Reference](https://www.secretflow.org.cn/docs/secretflow/en/api/index.html)
  - [Tutorial](https://www.secretflow.org.cn/docs/secretflow/en/tutorial/index.html)


## SecretFlow Related Projects

- [Kuscia](https://github.com/secretflow/kuscia): A K8s-based privacy computing task orchestration framework.
- [SCQL](https://github.com/secretflow/scql): A system that allows multiple distrusting parties to run joint analysis without revealing their private data.
- [SPU](https://github.com/secretflow/spu): A provable, measurable secure computation device, which provides computation ability while keeping your private data protected.
- [HEU](https://github.com/secretflow/heu): A high-performance homomorphic encryption algorithm library.
- [YACL](https://github.com/secretflow/yacl): A C++ library that contains cryptography, network and io modules which other SecretFlow code depends on.

## Install

Please check [INSTALLATION.md](./docs/getting_started/installation.md)

## Deployment

Please check [DEPLOYMENT.md](./docs/getting_started/deployment.md)

## Learn PETs

We also provide a curated list of papers and SecretFlow's tutorials on Privacy-Enhancing Technologies (PETs).

Please check [AWESOME-PETS.md](./docs/awesome-pets/awesome-pets.md)


## Contributing

Please check [CONTRIBUTING.md](./CONTRIBUTING.md)

## Disclaimer

Non-release versions of SecretFlow are prohibited from using in any production environment due to possible bugs, glitches, lack of functionality, security issues or other problems.
