diff --git a/docs/overview/python-package.rst b/docs/overview/python-package.rst index 004f16a..b48ddf7 100644 --- a/docs/overview/python-package.rst +++ b/docs/overview/python-package.rst @@ -9,6 +9,21 @@ Below is a diagram that provides insights on the relationship between Vulkan Kom .. image:: ../images/kompute-architecture.jpg :width: 70% +Package Installation +^^^^^^^^^ + +Once you set up the package dependencies, you can install Kompute from ```Pypi``` using ```pip``` by running: + +``` +pip install kp +``` + +You can also install from master branch using: + +``` +pip install git+git://github.com/EthicalML/vulkan-kompute.git@master +``` + Core Python Components ^^^^^^^^ @@ -272,28 +287,15 @@ Similar to the logistic regression implementation in the C++ examples section, b print(tensor_b_in.data()) -Package Installation -^^^^^^^^^ - -The package can be installed through the top level `setup.py` by running: - -``` -pip install kp -``` - -You can also install from master branch using: - -``` -pip install git+git://github.com/EthicalML/vulkan-kompute.git@master -``` +Log Level Configuration +^^^^^^ You can configure log level with the function `kp.log_level` as outlined below. The values are TRACE=0, DEBUG=1, INFO=2, WARN=3, ERROR=4. Kompute defaults to INFO. -``` -import kp -kp.log_level(1) -``` - +.. code-block:: python + :linenos: + import kp + kp.log_level(1) diff --git a/examples/python/README.md b/examples/python/README.md index 1b3736f..7d71f98 100644 --- a/examples/python/README.md +++ b/examples/python/README.md @@ -8,8 +8,8 @@ The easiest way to try this example is by using the [Google Binder Notebook](htt Alternatively if you want to test the example yourself you can follow the following links: -1. Install the Kompute Python Package -2. Run the Array Multiplication Code -3. Run the Logistic Regression Code +1. Install the [Kompute Python Package](https://kompute.cc/overview/python-package.html) +2. Run the [Array Multiplication Code]() +3. Run the [Logistic Regression Code]()