build: merge main

qiboteam · Nov 4, 2024 · 4bb6a5c · 4bb6a5c
2 parents 3dc291e + 3cd0a66
commit 4bb6a5c
Show file tree

Hide file tree

Showing 16 changed files with 1,018 additions and 87 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,7 @@
-# qiboml
+# Qiboml
 Quantum Machine Learning using Qibo
+
+We integrate the most widely used machine learning interface with the full-stack quantum computing utilities of Qibo.
+
+
+![qiboml_scheme](https://github.com/user-attachments/assets/feb56a25-8235-48ce-ba0b-d9237d9ef30e)
diff --git a/doc/Makefile b/doc/Makefile
@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+view: html
+	$(BROWSER) build/html/index.html
diff --git a/doc/source/_static/css/style.css b/doc/source/_static/css/style.css
@@ -0,0 +1,7 @@
+.wy-side-nav-search {
+    background-color: #6400FF;
+}
+
+.wy-nav-top {
+    background-color: #6400FF;
+}
diff --git a/doc/source/_static/qibo_logo_dark.svg b/doc/source/_static/qibo_logo_dark.svg
diff --git a/doc/source/_static/qibo_logo_light.svg b/doc/source/_static/qibo_logo_light.svg
diff --git a/doc/source/api-reference/qiboml.backends.rst b/doc/source/api-reference/qiboml.backends.rst
@@ -0,0 +1,34 @@
+qiboml.backends package
+=======================
+
+.. automodule:: qiboml.backends
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+qiboml.backends.jax module
+--------------------------
+
+.. automodule:: qiboml.backends.jax
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qiboml.backends.pytorch module
+------------------------------
+
+.. automodule:: qiboml.backends.pytorch
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+qiboml.backends.tensorflow module
+---------------------------------
+
+.. automodule:: qiboml.backends.tensorflow
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/source/api-reference/qiboml.rst b/doc/source/api-reference/qiboml.rst
@@ -0,0 +1,15 @@
+qiboml package
+==============
+
+.. automodule:: qiboml
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   qiboml.backends