Add more detailed docs for the ANN index and search features

This commit is contained in:
Chang She
2023-04-24 19:19:55 -07:00
parent 177192f852
commit 4f2dae8a0d
3 changed files with 34 additions and 13 deletions

View File

@@ -108,7 +108,12 @@ class LanceQueryBuilder:
return self
def to_df(self) -> pd.DataFrame:
"""Execute the query and return the results as a pandas DataFrame."""
"""
Execute the query and return the results as a pandas DataFrame.
In addition to the selected columns, LanceDB also returns a vector
and also the "score" column which is the distance between the query
vector and the returned vector.
"""
ds = self._table.to_lance()
# TODO indexed search
tbl = ds.to_table(