mirror of
https://github.com/lancedb/lancedb.git
synced 2025-12-24 05:49:57 +00:00
e1ae2bcbd8
Add `to_list` to return query results as list of python dict (so we're not too pandas-centric). Closes #555 Add `to_pandas` API and add deprecation warning on `to_df`. Closes #545 Co-authored-by: Chang She <chang@lancedb.com>
85 lines
1.2 KiB
Markdown
85 lines
1.2 KiB
Markdown
# LanceDB
|
|
|
|
A Python library for [LanceDB](https://github.com/lancedb/lancedb).
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pip install lancedb
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Basic Example
|
|
|
|
```python
|
|
import lancedb
|
|
db = lancedb.connect('<PATH_TO_LANCEDB_DATASET>')
|
|
table = db.open_table('my_table')
|
|
results = table.search([0.1, 0.3]).limit(20).to_list()
|
|
print(results)
|
|
```
|
|
|
|
|
|
## Development
|
|
|
|
Create a virtual environment and activate it:
|
|
|
|
```bash
|
|
python -m venv venv
|
|
. ./venv/bin/activate
|
|
```
|
|
|
|
Install the necessary packages:
|
|
|
|
```bash
|
|
python -m pip install .
|
|
```
|
|
|
|
To run the unit tests:
|
|
|
|
```bash
|
|
pytest
|
|
```
|
|
|
|
To run linter and automatically fix all errors:
|
|
|
|
```bash
|
|
black .
|
|
isort .
|
|
```
|
|
|
|
If any packages are missing, install them with:
|
|
|
|
```bash
|
|
pip install <PACKAGE_NAME>
|
|
```
|
|
|
|
|
|
___
|
|
For **Windows** users, there may be errors when installing packages, so these commands may be helpful:
|
|
|
|
Activate the virtual environment:
|
|
```bash
|
|
. .\venv\Scripts\activate
|
|
```
|
|
|
|
You may need to run the installs separately:
|
|
```bash
|
|
pip install -e .[tests]
|
|
pip install -e .[dev]
|
|
```
|
|
|
|
|
|
`tantivy` requires `rust` to be installed, so install it with `conda`, as it doesn't support windows installation:
|
|
```bash
|
|
pip install wheel
|
|
pip install cargo
|
|
conda install rust
|
|
pip install tantivy
|
|
```
|
|
|
|
To run the unit tests:
|
|
```bash
|
|
pytest
|
|
``` |