diff --git a/README.md b/README.md index 2ea8ae07..95549f6e 100644 --- a/README.md +++ b/README.md @@ -1,65 +1,78 @@ -# Cocos AI +
+ +# Cocos AI 🥥 + +**Confidential Computing System for AI** + +**Made with ❤️ by [Ultraviolet](https://ultraviolet.rs/)** [![codecov](https://codecov.io/gh/ultravioletrs/cocos/graph/badge.svg?token=HX01LR01K9)](https://codecov.io/gh/ultravioletrs/cocos) -![Go report card](https://goreportcard.com/badge/github.com/ultravioletrs/cocos) +[![Go report card](https://goreportcard.com/badge/github.com/ultravioletrs/cocos)](https://goreportcard.com/report/github.com/ultravioletrs/cocos) +[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE) -[Cocos AI (Confdential Computing System for AI/ML)][cocos] is a platform for secure multiparty computation (SMPC) -based on the [Confidential Computing][cc] and [Trusted Execution Environments (TEEs)][tee]. +### [Guide](https://docs.cocos.ultraviolet.rs) | [Contributing](CONTRIBUTING.md) | [Website](https://cocos.ai/) -

- -

+
+ +## Introduction 🚀 -With Cocos AI it becomes possible to run AI/ML workloads on combined datasets from multiple organizations -while guaranteeing the privacy and security of the data and the algorithm. -Data is always encrypted, protected by hardware secure enclaves (Trusted Execution Environments), -attested via secure remote attestation protocols, and invisible to cloud processors or any other -3rd party to which computation is offloaded. +Cocos AI is a **cutting-edge platform** designed to enable secure multiparty computation (SMPC) using **Confidential Computing** and **Trusted Execution Environments (TEEs)**. -## Features +It empowers organizations to collaboratively process sensitive data for AI/ML workloads while ensuring: -Cocos AI is implementing the following features: +- 🔒 **Data Privacy**: Your data stays encrypted and secure throughout the computation. +- 🛡️ **Trust and Integrity**: Protected by hardware enclaves with robust remote attestation protocols. +- 🤝 **Seamless Collaboration**: Multiple organizations can work together without exposing sensitive information. -- TEE enablement, deployment and monitoring (secure VM manager) -- HAL for TEEs based on hardened Linux kernel, secure bootloader and custom-tailored embedded rootfs for minimal TCB -- In-enclave agent, netowrking controller and other system software -- Encrypted asynchronous data transfer and result delivery -- API for programmable platform manipulation -- HW and SW supported attestation with verification tools -- CLI for system interaction +

+ Cocos AI Illustration +

+ +## Features 🛠️ -## Usage +Cocos AI provides essential features for secure and efficient collaborative AI/ML: -Clone the repo and create binaries: +- 🖥️ **TEE Enablement and Monitoring**: Secure VM management for deploying and monitoring workloads. +- 🛡️ **Hardware Abstraction Layer (HAL)**: Built on a hardened Linux kernel, secure bootloader, and minimal root filesystem (minimal TCB). +- 🕵️ **In-Enclave Agent and Networking Controller**: Essential system software for managing secure workloads. +- 🔒 **Encrypted Data Transfer**: Asynchronous data transfer and secure result delivery. +- 🛠️ **API for Platform Manipulation**: Programmatic control for managing workloads. +- ✅ **Attestation and Verification Tools**: Hardware- and software-supported attestation for integrity assurance. +- 🖱️ **Command-Line Interface (CLI)**: A user-friendly CLI for system interaction. +## 🚀 Quick Start + +### Clone the Repository and Build Binaries ```bash git clone git@github.com:ultravioletrs/cocos.git make ``` -This will create 3 binaries: +This will generate three binaries: ```bash ls build/ # cocos-agent cocos-cli cocos-manager ``` -- Manager can be deployed on the AMD SEV-SNP host -- Agent can be built into [EOS][eos]-based HAL -- CLI can be used to communicate to remote Agent. +### Deployment Overview: +- **Manager**: Deploy on the AMD SEV-SNP host to orchestrate workloads. +- **Agent**: Build into the [EOS](https://github.com/ultravioletrs/eos)-based HAL for secure enclave management. +- **CLI**: Interact with remote agents to control operations. + +## 📚 Documentation + +Comprehensive documentation is available at the [official documentation page](https://docs.cocos.ultraviolet.rs). +For CLI usage details, visit the [CLI Documentation](https://docs.cocos.ultraviolet.rs/cli). -## Documentation +Documentation is automatically generated from the [docs repository](https://github.com/ultravioletrs/docs). Contributions to documentation are welcome! -Project documentation is hosted at [Cocos AI official docs page][docs]. +## 🛡️ License -Documentation is generated from the [docs repository](https://github.com/ultravioletrs/docs). +Cocos AI is published under the permissive open-source [Apache-2.0](LICENSE) license. Contributions are encouraged and appreciated! -## License -Cocos AI is published under permissive open-source [Apache-2.0](LICENSE) license. +## 🌐 Links and Resources -[cc]: https://confidentialcomputing.io/white-papers-reports/ -[cocos]: https://cocos.ai/ -[rel]: https://github.com/ultravioletrs/cocos/releases -[tee]: https://en.wikipedia.org/wiki/Trusted_execution_environment -[docs]: https://docs.cocos.ultraviolet.rs -[cli]: https://docs.cocos.ultraviolet.rs/cli -[eos]: https://github.com/ultravioletrs/eos +- [Cocos AI Website](https://cocos.ai/) +- [Official Releases](https://github.com/ultravioletrs/cocos/releases) +- [Confidential Computing Overview](https://confidentialcomputing.io/white-papers-reports/) +- [Trusted Execution Environments (TEEs)](https://en.wikipedia.org/wiki/Trusted_execution_environment)