From 67f8adb8e1e80cfd9dd3e0da5b59c3bcb86122a3 Mon Sep 17 00:00:00 2001 From: Alejandro Saucedo Date: Wed, 11 Nov 2020 08:44:45 +0000 Subject: [PATCH] Updated documentation --- docs/overview/python-package.rst | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/docs/overview/python-package.rst b/docs/overview/python-package.rst index b48ddf771..c034e6244 100644 --- a/docs/overview/python-package.rst +++ b/docs/overview/python-package.rst @@ -2,7 +2,7 @@ Python Package Overview ======== -This section provides an overview of the Python Package from a functionality perspective. If you wish to see all the classes and their respective functions you can find that in the `Python Class Reference Section `_. +This section provides an overview of the Python Package from a functionality perspective. If you wish to see all the classes and their respective functions you can find that in the `Python Class Reference Section `_. Below is a diagram that provides insights on the relationship between Vulkan Kompute objects and Vulkan resources, which primarily encompass ownership of either CPU and/or GPU memory. @@ -14,15 +14,15 @@ Package Installation Once you set up the package dependencies, you can install Kompute from ```Pypi``` using ```pip``` by running: -``` -pip install kp -``` +.. code-block:: bash + + pip install kp You can also install from master branch using: -``` -pip install git+git://github.com/EthicalML/vulkan-kompute.git@master -``` +.. code-block:: python + + pip install git+git://github.com/EthicalML/vulkan-kompute.git@master Core Python Components ^^^^^^^^ @@ -296,6 +296,7 @@ The values are TRACE=0, DEBUG=1, INFO=2, WARN=3, ERROR=4. Kompute defaults to IN .. code-block:: python :linenos: + import kp kp.log_level(1)