Skip to content

Commit

Permalink
Update README.md (#79)
Browse files Browse the repository at this point in the history
  • Loading branch information
gcattan authored Sep 20, 2022
1 parent df7f4be commit a9ca033
Showing 1 changed file with 4 additions and 36 deletions.
40 changes: 4 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ classification with Riemannian geometry. A use case would be to use vectorized
covariance matrices in the TangentSpace as an input for these classifiers,
enabling a possible sandbox for researchers and engineers in the field.

The remaining details some of the quantum drawbacks and will guide you through installation.
Full documentation, including API description, is available at <https://pyriemann-qiskit.readthedocs.io/>.
The repository also includes a [wiki](https://github.com/pyRiemann/pyRiemann-qiskit/wiki) where you can find additional information.

## Quantum drawbacks

- Limitation of the feature dimension
Expand Down Expand Up @@ -89,8 +93,6 @@ To check the installation, open a python shell and type:
import pyriemann_qiskit
```

Full documentation, including API description, is available at <https://pyriemann-qiskit.readthedocs.io/>

To run a specific example on your local machine, you should install first dependencies for the documentation:

```
Expand Down Expand Up @@ -156,40 +158,6 @@ Code contribution (pull request) can be either on core functionalities, document
Workflows are automatically triggered when you push a commit. However, the worflow for example execution is only triggered when you modify one of the examples or the documentation as the execution take a lot of time. You can enable [Github Actions](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository) in your fork to see the result of the CI pipeline. Results are also indicated at the end of your pull request when raised. However note, that workflows in the pull request need approval from the maintainers before being executed.
### Deploy an example on the cloud
When creating an example, your local computer may be limited in terms of ressources to emulate a quantum computer.
Instead, you might want to use a cloud provider to run the example.
Here we will provide the steps with the Google Cloud Plateform (other cloud providers offer similar functionnalities):
1. Create a new branch with you example in your fork repository. Modify the `/Dockerfile` to redirect the `entrypoint` to your example.
Make sure that the `create_docker_image` workflow passed.
2. Open an account on Google Cloud (it required a billing account, but you will not be charged until you upgrade your account).
3. Create a [Cloud Run Service](https://console.cloud.google.com/run/create?project=pyriemann-qiskit) called `pyriemmann-qiskit` (or any project name which is suitable for you).
For the moment use the default configuration, although you may want to already indicate the physical ressources:
![image](https://user-images.githubusercontent.com/6229031/176449146-d3c3da37-0382-46e6-a20b-1b963ce6c12a.png)
4. Create an [artifactory repository](https://console.cloud.google.com/artifacts/create-repo?project=pyriemann-qiskit), following
the `Create a Docker repository in Artifactory` tutorial. Tutorials are displayed in the right side panel of the plateform.
Make sure to indicate `pyriemann-qiskit` as a project (or the one you created instead).
5. Create a new [Cloud Build Trigger](https://console.cloud.google.com/cloud-build/triggers?project=pyriemann-qiskit). Provide the required permissions to install the `Google Build app` on Github. This will allow Google Cloud to build a container image directly from your fork repository. The process is automated and you only need to follow the steps. For more details click [here](https://cloud.google.com/build/docs/automating-builds/build-repos-from-github).
6. Under `Configuration>Type`, select `Dockerfile`.
7. Under `Configuration>Location`, select `Repository` and type `Dockerfile` in the input box `Dockerfile name`.
8. Under `Configuration>Location` provide a value for the image name.
It should be in the form: `<XXX>-docker.pkg.dev/<name of your cloud run service>/<name of your docker repo>/<custom image name>:$COMMIT_SHA`.
You can copy the first part of this URL (except the image name) from your artifactory settings:
![image](https://user-images.githubusercontent.com/6229031/176449496-daf5f263-3bb9-4eb9-aad3-7bcf289b8f59.png)
9. Validate the trigger, and run it. Check everything passed.
10. Edit the service you created in step `3`, and select a `Container Image URL`. If everything went well,
a new image should have been pushed in your artifact repository. It is also possible to specify a different entrypoint that the one provided in setp `1`
![image](https://user-images.githubusercontent.com/6229031/176448796-8d2472c5-5662-4b69-8d47-c31ebbe9a7e5.png)
11. Validate the service and click on the `Logs` tab to see the output.
# Troubleshooting
## Version of pyRiemann not updated
Expand Down

0 comments on commit a9ca033

Please sign in to comment.