Skip to content

Commit 0fd029b

Browse files
authored
Typo Fix README.md (#2)
Fixed a couple of typos
1 parent de149a8 commit 0fd029b

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# VectorLink: The TerminusDB Semantic Indexer
22

33
VectorLink is a vector database with an index based on Hierarchical
4-
Navigable Small World graphs written in rust. It is designed to work
4+
Navigable Small World graphs written in Rust. It is designed to work
55
closely with TerminusDB but can be used with any project via a simple
6-
HTTP api. In order to work well with TerminusDB it is designed with
6+
HTTP API. In order to work well with TerminusDB it is designed with
77
the following features:
88

9-
* Domains: The database can manage several domains. In a domain you
10-
have a vector store which is append only. This allows you to share
9+
* Domains: The database can manage several domains. In a domain, you
10+
have a vector store which is append-only. This allows you to share
1111
vectors across indexes.
1212
* Commits: Each index exists at a commit. The index can point to any
1313
vector in a domain. This allows us to add and remove vectors by
@@ -21,7 +21,7 @@ To invoke the server, you can run it as follows:
2121

2222
## Compiling
2323

24-
You can comile the system with cargo:
24+
You can compile the system with cargo:
2525

2626
```shell
2727
cargo compile --release
@@ -49,7 +49,7 @@ If you wan to index documents, you can any of these methods:
4949
`TERMINUSDB_CONTENT_ENDPOINT/{domain}?commit_id={commit}`
5050
* use the `load` command with a file
5151

52-
In any of these cases, the indexer expects a content stream which will
52+
In any of these cases, the indexer expects a content stream that will
5353
have the form (in JSONlines format):
5454

5555
```json
@@ -86,19 +86,19 @@ indexing (specified by the `id` field).
8686

8787
## Todo
8888

89-
Lots of work to make this the open source versioned vector database
89+
Lots of work to make this the open-source versioned vector database
9090
that the world deserves. Anyone who wants to work on the project to
9191
advance these aims is welcome:
9292

9393
* Add other AI configurations for obtaining the embeddings - we'd like
9494
to be very complete and have ways of configuring other vendors and
95-
open source text-to-embedding systems.
95+
open-source text-to-embedding systems.
9696
* Greater scope of metric support
9797
* Improve compression: We'd like to have a sytem of vector compression
9898
such as PQ for dealing with very large datasets.
9999
* Better treatment of deletion and replace
100100
* Better incrementality of the index structure
101-
* Smaller graph reprsentations of the indicies - using succinct data
101+
* Smaller graph representations of the indices - using succinct data
102102
structures to reduce memory overhead.
103103

104104
And if you have new ideas we'd love to hear them!

0 commit comments

Comments
 (0)