Skip to content

Commit

Permalink
docs: update main landing pages
Browse files Browse the repository at this point in the history
  • Loading branch information
yuxizama authored Mar 29, 2024
1 parent b0b9f50 commit cfb862e
Show file tree
Hide file tree
Showing 15 changed files with 38 additions and 11 deletions.
14 changes: 11 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
<p align="center">
<!-- product name logo -->
<img width=600 src="https://user-images.githubusercontent.com/5758427/231206363-a6639df8-2253-40d8-836e-e3c22d36d6ad.png">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/zama-ai/concrete-ml/assets/157474013/5ed658d7-0abd-4444-9063-99d8b76c2602">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/zama-ai/concrete-ml/assets/157474013/7c67e594-5e2c-483e-858f-ce473a36e37f">
<img width=600 alt="Zama Concrete ML">
</picture>
</p>

<hr>
Expand Down Expand Up @@ -254,11 +258,15 @@ This software is distributed under the **BSD-3-Clause-Clear** license. If you ha
## Support

<a target="_blank" href="https://community.zama.ai">
<img src="https://github.com/zama-ai/concrete-ml/assets/157474013/0cb69022-fd02-4dbc-801b-51401f3bc07c">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/zama-ai/concrete-ml/assets/157474013/86502167-4ea4-49e9-a881-0cf97d141818">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/zama-ai/concrete-ml/assets/157474013/3dcf41e2-1c00-471b-be53-2c804879b8cb">
<img alt="Support">
</picture>
</a>

🌟 If you find this project helpful or interesting, please consider giving it a star on GitHub! Your support helps to grow the community and motivates further development.

<p align="right">
<a href="#tabout" > ↑ Back to top </a>
<a href="#about" > ↑ Back to top </a>
</p>
Binary file removed docs/.gitbook/assets/fundamentals.jpg
Binary file not shown.
Binary file removed docs/.gitbook/assets/getstarted1.jpg
Binary file not shown.
Binary file removed docs/.gitbook/assets/getstarted2.jpg
Binary file not shown.
Binary file removed docs/.gitbook/assets/getstarted3.jpg
Binary file not shown.
Binary file removed docs/.gitbook/assets/guides.jpg
Binary file not shown.
Binary file added docs/.gitbook/assets/orange1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/orange2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/orange3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/.gitbook/assets/tutorials.jpg
Binary file not shown.
Binary file added docs/.gitbook/assets/yellow1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/yellow2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/.gitbook/assets/yellow3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 26 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,38 @@
description: >-
Concrete ML is an open-source, privacy-preserving, machine learning framework
based on Fully Homomorphic Encryption (FHE).
layout:
title:
visible: true
description:
visible: true
tableOfContents:
visible: true
outline:
visible: true
pagination:
visible: false
---

# Welcome

## Start here
## Get started

Learn the basics of Concrete ML, set it up, and make it run with ease.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>What is Concrete ML</strong></td><td><a href=".gitbook/assets/getstarted1.jpg">getstarted1.jpg</a></td><td><a href="getting-started/">getting-started</a></td></tr><tr><td><strong>Installation</strong></td><td><a href=".gitbook/assets/getstarted2.jpg">getstarted2.jpg</a></td><td><a href="getting-started/pip_installing.md">pip_installing.md</a></td></tr><tr><td><strong>Key concepts</strong></td><td><a href=".gitbook/assets/getstarted3.jpg">getstarted3.jpg</a></td><td><a href="getting-started/concepts.md">concepts.md</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>What is Concrete ML</strong></td><td><a href=".gitbook/assets/yellow1.png">yellow1.png</a></td><td><a href="getting-started/">getting-started</a></td></tr><tr><td><strong>Installation</strong></td><td><a href=".gitbook/assets/yellow2.png">yellow2.png</a></td><td><a href="getting-started/pip_installing.md">pip_installing.md</a></td></tr><tr><td><strong>Key concepts</strong></td><td><a href=".gitbook/assets/yellow3.png">yellow3.png</a></td><td><a href="getting-started/concepts.md">concepts.md</a></td></tr></tbody></table>

## Build with Concrete ML

Start building with Concrete ML by exploring its core features, discovering essential guides, and learning more with user-friendly tutorials.

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Fundamentals</strong></td><td>Explore core features and basics of Concrete ML.</td><td><ul><li><a href="tutorials/ml_examples.md">Build-in models</a></li><li><a href="tutorials/dl_examples.md">Deep learning</a></li></ul></td><td></td><td><a href=".gitbook/assets/fundamentals.jpg">fundamentals.jpg</a></td></tr><tr><td><strong>Guides</strong></td><td>Discover essential guides to work with Concrete ML.</td><td><ul><li><a href="guides/prediction_with_fhe.md">Prediction with FHE</a></li><li><a href="guides/client_server.md">Production deployment</a></li><li><a href="guides/hybrid-models.md">Hybrid models</a></li></ul></td><td></td><td><a href=".gitbook/assets/guides.jpg">guides.jpg</a></td></tr><tr><td><strong>Tutorials</strong></td><td>Learn more about Concrete ML with our tutorials.</td><td><ul><li><a href="tutorials/showcase.md#start-here">Start here</a></li><li><a href="tutorials/showcase.md#go-further">Go further</a></li><li><a href="tutorials/showcase.md">See all tutorials</a></li></ul></td><td></td><td><a href=".gitbook/assets/tutorials.jpg">tutorials.jpg</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><strong>Fundamentals</strong></td><td>Explore core features and basics of Concrete ML.<br><br></td><td><ul><li><a href="tutorials/ml_examples.md">Build-in models</a></li><li><a href="tutorials/dl_examples.md">Deep learning</a></li></ul></td><td></td><td><a href=".gitbook/assets/orange1.png">orange1.png</a></td></tr><tr><td><strong>Guides</strong></td><td>Discover essential guides to work with Concrete ML.<br><br></td><td><ul><li><a href="guides/prediction_with_fhe.md">Prediction with FHE</a></li><li><a href="guides/client_server.md">Production deployment</a></li><li><a href="guides/hybrid-models.md">Hybrid models</a></li></ul></td><td></td><td><a href=".gitbook/assets/orange2.png">orange2.png</a></td></tr><tr><td><strong>Tutorials</strong></td><td>Learn more about Concrete ML with our tutorials.<br><br></td><td><ul><li><a href="tutorials/showcase.md#start-here">Start here</a></li><li><a href="tutorials/showcase.md#go-further">Go further</a></li><li><a href="tutorials/showcase.md">See all tutorials</a></li></ul></td><td></td><td><a href=".gitbook/assets/orange3.png">orange3.png</a></td></tr></tbody></table>

## References & Explanations
## Explore more

Access to additional resources and join the Zama community.

### References & Explanations

Refer to the API, review product architecture, and access additional resources for in-depth explanations while working with Concrete ML.

Expand All @@ -29,18 +44,22 @@ Refer to the API, review product architecture, and access additional resources f
- [Advanced features](explanations/advanced_features.md)
- [Project architecture](explanations/inner-workings/)

## Supports
### Supports

Ask technical questions and discuss with the community. Our team of experts usually answers within 24 hours in working days.

- [Community forum](https://community.zama.ai/)
- [Community forum](https://community.zama.ai/c/concrete-ml/8)
- [Discord channel](https://discord.fhe.org/)

## Developers
### Developers

Collaborate with us to advance the FHE spaces and drive innovation together.

- [Contribute to Concrete ML](developer/contributing.md)
- [Check the latest release note](https://github.com/zama-ai/concrete-ml/releases)
- [Request a feature](https://github.com/zama-ai/concrete-ml/issues/new?assignees=&labels=feature&projects=&template=feature_request.md)
- [Report a bug](https://github.com/zama-ai/concrete-ml/issues/new?assignees=&labels=bug&projects=&template=bug_report.md)

______________________________________________________________________

We value your feedback! [Take a 5-question developer survey](https://zama-project.webflow.io/developer-survey) to improve the Concrete ML library and the documentation and help other developers use FHE.
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
- [FHE Op-graph design](explanations/inner-workings/fhe-op-graphs.md)
- [External libraries](explanations/inner-workings/external_libraries.md)

## Developer
## Developers

- [Set up the project](developer/project_setup.md)
- [Set up Docker](developer/docker_setup.md)
Expand Down

0 comments on commit cfb862e

Please sign in to comment.