Skip to content

Commit 72464cf

Browse files
committed
Modified readme with helpful links, added tutorial jupyter notebook file
1 parent 62ee7f8 commit 72464cf

File tree

4 files changed

+75
-71
lines changed

4 files changed

+75
-71
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,18 @@
1-
# Timescale-vector
1+
# Timescale Vector
22

33
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
44

5-
This file will become your README and also the index of your
6-
documentation.
5+
PostgreSQL++ for AI Applications.
6+
7+
- [Documentation and
8+
Tutorials](https://timescale.github.io/python-vector/).
9+
- [Signup for Timescale
10+
Vector](https://console.cloud.timescale.com/signup?utm_campaign=vectorlaunch&utm_source=github&utm_medium=direct):
11+
Get 90 days free to try Timescale Vector on the Timescale cloud data
12+
platform. There is no self-managed version at this time.
13+
- [Learn
14+
more](https://www.timescale.com/blog/how-we-made-postgresql-the-best-vector-database/?utm_campaign=vectorlaunch&utm_source=github&utm_medium=direct):
15+
Learn more about Timescale Vector, how it works and why we built it.
716

817
## Install
918

@@ -276,6 +285,5 @@ rec = await vec.search([1.0, 2.0], limit=4, uuid_time_filter=client.UUIDTimeRang
276285

277286
## Development
278287

279-
Please note that this project is developed with
280-
[nbdev](https://nbdev.fast.ai/). Please see that website for the
281-
development process.
288+
This project is developed with [nbdev](https://nbdev.fast.ai/). Please
289+
see that website for the development process.

nbs/index.ipynb

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,19 @@
55
"cell_type": "markdown",
66
"metadata": {},
77
"source": [
8-
"# Timescale-vector\n",
9-
"\n",
10-
"> Python library for storing vector data in Postgres"
8+
"# Timescale Vector"
119
]
1210
},
1311
{
1412
"attachments": {},
1513
"cell_type": "markdown",
1614
"metadata": {},
1715
"source": [
18-
"This file will become your README and also the index of your documentation."
16+
"PostgreSQL++ for AI Applications.\n",
17+
"\n",
18+
"- [Documentation and Tutorials](https://timescale.github.io/python-vector/).\n",
19+
"- [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",
20+
"- [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."
1921
]
2022
},
2123
{
@@ -670,7 +672,7 @@
670672
"source": [
671673
"## Development\n",
672674
"\n",
673-
"Please note that this project is developed with [nbdev](https://nbdev.fast.ai/). Please see that website for the development process."
675+
"This project is developed with [nbdev](https://nbdev.fast.ai/). Please see that website for the development process."
674676
]
675677
},
676678
{

nbs/sidebar.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ website:
33
contents:
44
- index.ipynb
55
- 00_vector.ipynb
6+
- tsv_python_getting_started_tutorial.ipynb

0 commit comments

Comments
 (0)