Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readme: Restructure the readme, improve Getting Started and explanations #36

Merged
merged 6 commits into from
Apr 11, 2022

Conversation

cchudant
Copy link

@cchudant cchudant commented Apr 6, 2022

Description

Click to see the rendered version

Restructure the Readme, improve Getting Started and explanations.

Leaving as Draft PR until we can update the "TODO"s

What we may want to change:

  • Link to docs may be easy to miss (i think it's ok as long as we can find it easily when we need it)
  • Added more links to the documentation, but we may want some more
  • I have moved the examples more to the bottom => is it ok or should we display them more
  • Rust -> we may want to display it more
  • When reading the readme, I can think of some questions one may ask: (i expect them to be the top questions)
    => we may want to put them in the FAQ section in the docs :)
    • Does my CPU work with Intel SGX? Which one are OK? => we may want a whole documentation page about that and link it in the readme
    • What about speed? Is inference slow on a CPU?
    • Want to learn more about how SGX works (technical audience, with lower level explanation that what our blogposts provide)
    • threat model for Intel SGX in general => is this secure against physical attacks and stuff

Related Issue

None

Type of change

  • This change requires a documentation update
  • This change affects the client
  • This change affects the server
  • This change affects the API
  • This change only concerns the documentation

How Has This Been Tested?

N/A

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I have updated the documentation according to my changes

@cchudant cchudant marked this pull request as draft April 6, 2022 15:04
Deploy the inference server, for instance using one of our *Docker* images. To get started quickly, you can use the image with simulation, which does not require any specific hardware.
#### Install the python library

If you feel extra-lazy, we also have a Jupyter notebook environment you can just pull and use, just run
Copy link
Author

@cchudant cchudant Apr 6, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i am not too happy with this wording
this may need to move in another section, but I couldn't find any other place that feels natural

@JoFrost JoFrost marked this pull request as ready for review April 11, 2022 10:03
@JoFrost JoFrost merged commit 58afdac into master Apr 11, 2022
@cchudant cchudant mentioned this pull request Apr 11, 2022
10 tasks
@JoFrost JoFrost deleted the readme-fix branch April 11, 2022 20:41
ShannonSD pushed a commit to ShannonSD/blindai that referenced this pull request Jun 14, 2022
readme: Restructure the readme, improve Getting Started and explanations
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants