diff options
author | tmartins <thigm85@gmail.com> | 2020-09-02 11:55:11 +0200 |
---|---|---|
committer | tmartins <thigm85@gmail.com> | 2020-09-02 11:55:11 +0200 |
commit | 4191cf0c0dff20f8c360c676a2ab0fcb793b6de8 (patch) | |
tree | 349045069edd1ce6de5ee4619f30cf9c9f3aed4d /python | |
parent | 0dfd7db8c4a0f89cb9d14a402f40f486664ca897 (diff) |
add info to index
Diffstat (limited to 'python')
-rw-r--r-- | python/vespa/docs/sphinx/source/index.rst | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/python/vespa/docs/sphinx/source/index.rst b/python/vespa/docs/sphinx/source/index.rst index cd180ec49dc..9901e0cca80 100644 --- a/python/vespa/docs/sphinx/source/index.rst +++ b/python/vespa/docs/sphinx/source/index.rst @@ -10,6 +10,8 @@ Vespa python API :hidden: install + quickstart + howto reference-api ``pyvespa`` provides a python API to vespa.ai_. It allow us to create, modify, deploy and interact with @@ -18,6 +20,7 @@ Machine Learning experiments around Vespa applications. .. _vespa.ai: https://vespa.ai/ + Install +++++++ @@ -27,18 +30,24 @@ You can install ``pyvespa`` via ``pip``: pip install pyvespa -Connecting to a running Vespa instance -++++++++++++++++++++++++++++++++++++++ - -If you have a running Vespa instance that you would like to experiment with, you connect to it with :class:`vespa.application.Vespa` - +Quick-start ++++++++++++ -.. code-block:: python +The best way to get started is by following the tutorials below. You can easily run them yourself on Google Colab +by clicking on the badge at the top of the tutorial. - from vespa.application import Vespa - app = Vespa(url = "https://api.cord19.vespa.ai") +- :doc:`Connect and interact with CORD-19 search app <connect-to-vespa-instance>`. +- :doc:`Create and deploy a MS MARCO search app from scratch <create-and-deploy-vespa-cloud>`. +How-to guides ++++++++++++++ +- :doc:`Create Vespa application packages <application-package>`. +- :doc:`Deploy Vespa applications to Vespa Cloud or to Docker containers <deploy-application>`. +- :doc:`Define query models <query-model>`. +- :doc:`Query Vespa applications <query>`. +- :doc:`Evaluate query models <evaluation>`. +- :doc:`Collect training data from Vespa applications <collect-training-data>`. Indices and tables ================== |