Skip to content

Commit f79efd1

Browse files
committed
Added getting started tutorial to README. Added jupyter notebook download to tutorial.
1 parent 72464cf commit f79efd1

File tree

3 files changed

+18
-3
lines changed

3 files changed

+18
-3
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,16 @@
44

55
PostgreSQL++ for AI Applications.
66

7-
- [Documentation and
8-
Tutorials](https://timescale.github.io/python-vector/).
97
- [Signup for Timescale
108
Vector](https://console.cloud.timescale.com/signup?utm_campaign=vectorlaunch&utm_source=github&utm_medium=direct):
119
Get 90 days free to try Timescale Vector on the Timescale cloud data
1210
platform. There is no self-managed version at this time.
11+
- [Documentation](https://timescale.github.io/python-vector/): Learn the
12+
key features of Timescale Vector and how to use them.
13+
- [Getting Started
14+
Tutorial](https://timescale.github.io/python-vector/tsv_python_getting_started_tutorial.html):
15+
Learn how to use Timescale Vector for semantic search on a real world
16+
dataset.
1317
- [Learn
1418
more](https://www.timescale.com/blog/how-we-made-postgresql-the-best-vector-database/?utm_campaign=vectorlaunch&utm_source=github&utm_medium=direct):
1519
Learn more about Timescale Vector, how it works and why we built it.

nbs/index.ipynb

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@
1515
"source": [
1616
"PostgreSQL++ for AI Applications.\n",
1717
"\n",
18-
"- [Documentation and Tutorials](https://timescale.github.io/python-vector/).\n",
1918
"- [Signup for Timescale Vector](https://console.cloud.timescale.com/signup?utm_campaign=vectorlaunch&utm_source=github&utm_medium=direct): Get 90 days free to try Timescale Vector on the Timescale cloud data platform. There is no self-managed version at this time.\n",
19+
"- [Documentation](https://timescale.github.io/python-vector/): Learn the key features of Timescale Vector and how to use them.\n",
20+
"- [Getting Started Tutorial](https://timescale.github.io/python-vector/tsv_python_getting_started_tutorial.html): Learn how to use Timescale Vector for semantic search on a real world dataset.\n",
2021
"- [Learn more](https://www.timescale.com/blog/how-we-made-postgresql-the-best-vector-database/?utm_campaign=vectorlaunch&utm_source=github&utm_medium=direct): Learn more about Timescale Vector, how it works and why we built it."
2122
]
2223
},

nbs/tsv_python_getting_started_tutorial.ipynb

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515
"source": [
1616
"This notebook shows how to use the PostgreSQL vector database `Timescale Vector` via the [Timescale Vector python client library](https://github.com/timescale/python-vector). You'll learn how to use TimescaleVector for (1) semantic search, (2) time-based vector search, (3) and how to create indexes to speed up queries.\n",
1717
"\n",
18+
"Follow along by downloading the [Jupyter notebook version of this tutorial here](https://github.com/timescale/python-vector/blob/main/nbs/tsv_python_getting_started_tutorial.ipynb).\n",
19+
"\n",
1820
"Sample dataset: We'll analyze a gitlog dataset (git commit messages) and use the vector embeddings of the commit messages to find relevant commit messages to a given query question. Each git commit entry has a timestamp associated with it, as well as natural language message and other metadata (e.g author, commit hash etc). \n",
1921
"\n",
2022
"## What is Timescale Vector?\n",
@@ -49,6 +51,14 @@
4951
"## 0. Setup"
5052
]
5153
},
54+
{
55+
"attachments": {},
56+
"cell_type": "markdown",
57+
"metadata": {},
58+
"source": [
59+
"Download the [Jupyter notebook version of this tutorial](https://github.com/timescale/python-vector/blob/main/nbs/tsv_python_getting_started_tutorial.ipynb)."
60+
]
61+
},
5262
{
5363
"cell_type": "code",
5464
"execution_count": null,

0 commit comments

Comments
 (0)