From c4adfcffb10710ed0bfa925026448aac2e01c0e6 Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Wed, 16 Jul 2025 20:15:34 +0530 Subject: [PATCH 01/14] docs: add uv installation prompt and fallback usage in README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 911f192..5cfa753 100644 --- a/README.md +++ b/README.md @@ -20,9 +20,25 @@ Lance-Ray combines the distributed computing capabilities of Ray with the effici # Install from source git clone https://github.com/lance-ray/lance-ray.git cd lance-ray + +# if uv is not installed +pip install uv + +# if 'uv' command is not recognized (especially on windows) +#then restart your terminal or use: +#python -m uv pip install -e . + uv pip install -e . # Or install with development dependencies + +# if 'uv' is not installed +pip install uv + +# If 'uv' command is still not recognized (especially on Windows), +# try restarting your terminal or use: +# python -m uv pip install -e ".[dev]" + uv pip install -e ".[dev]" ``` From b29bad6ac6dadc6e6f3eec0c6b4e2adbf68284b7 Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Sun, 20 Jul 2025 20:59:23 +0530 Subject: [PATCH 02/14] docs: Add quick-start guide and update documentation structure --- docs/contributing.md | 1 + docs/getting-started/installation.md | 1 + docs/getting-started/quick-start.md | 17 +++++++++++++++++ docs/index.md | 20 ++++++++++++++++++++ docs/usage.md | 1 + mkdocs.yml | 9 +++++++++ 6 files changed, 49 insertions(+) create mode 100644 docs/contributing.md create mode 100644 docs/getting-started/installation.md create mode 100644 docs/getting-started/quick-start.md create mode 100644 docs/index.md create mode 100644 docs/usage.md create mode 100644 mkdocs.yml diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..fafcf92 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1 @@ +# contribution Guidelines diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md new file mode 100644 index 0000000..f34d65b --- /dev/null +++ b/docs/getting-started/installation.md @@ -0,0 +1 @@ +# Installation \ No newline at end of file diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md new file mode 100644 index 0000000..2bb9905 --- /dev/null +++ b/docs/getting-started/quick-start.md @@ -0,0 +1,17 @@ +# Quick Start + +Welcome to the LanceDB + Ray integration quick start guide! + +This guide will show you: +how to Install the required libraries. +how to Create a vector store using LanceDB. +how to Use Ray to scale the processing. + +## Prerequisites + +Ensure you have Python 3.8+ and pip installed. + +## Installation + +```bash +pip install lancedb ray diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..e61a809 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,20 @@ +# LanceDB + Ray Integration Docs + +Welcome to the official documentation for integrating **LanceDB** with **Ray** for scalable vector processing. + +This guide helps you: + +- Install LanceDB and Ray +- Create and manage vector stores using LanceDB +- Use Ray to scale embedding generation and queries +- Combine the power of Ray with LanceDB for distributed applications + +## Sections + +- [Getting Started](getting-started/quick-start.md): Setup and basic usage +- [Usage](usage.md): Examples, best practices, and advanced features +- [Contributing](contributing.md): How to contribute to this documentation + +--- + +Start by visiting the [Quick Start](getting-started/quick-start.md) guide! diff --git a/docs/usage.md b/docs/usage.md new file mode 100644 index 0000000..e026544 --- /dev/null +++ b/docs/usage.md @@ -0,0 +1 @@ +# how to use lance-ray diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..0a88042 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,9 @@ +site_name: Lance-Ray Documentation + +nav: + - Home: index.md + - Getting Started: + - Installation: getting-started/installation.md + - Quick Start: getting-started/quick-start.md + - Usage: usage.md + - Contributing: contributing.md From 3e269aca4832711261f93156f8d614552ac899ab Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Sun, 27 Jul 2025 23:23:28 +0530 Subject: [PATCH 03/14] docs: add complete documentation with MkDocs --- docs/LICENSE.md | 9 ++++++ docs/api_reference.md | 13 ++++++++ docs/contributing.md | 22 +++++++++++++- docs/development.md | 23 ++++++++++++++ docs/examples.md | 45 ++++++++++++++++++++++++++++ docs/getting-started/installation.md | 1 - docs/getting-started/quick-start.md | 17 ----------- docs/index.md | 42 ++++++++++++++++++-------- docs/installation.md | 25 ++++++++++++++++ docs/usage.md | 1 - mkdocs.yml | 9 +++--- 11 files changed, 170 insertions(+), 37 deletions(-) create mode 100644 docs/LICENSE.md create mode 100644 docs/api_reference.md create mode 100644 docs/development.md create mode 100644 docs/examples.md delete mode 100644 docs/getting-started/installation.md delete mode 100644 docs/getting-started/quick-start.md create mode 100644 docs/installation.md delete mode 100644 docs/usage.md diff --git a/docs/LICENSE.md b/docs/LICENSE.md new file mode 100644 index 0000000..0604f0f --- /dev/null +++ b/docs/LICENSE.md @@ -0,0 +1,9 @@ +# License + +This project is licensed under the Apache License 2.0. +See the [LICENSE](../LICENSE) file for full details. + +## Acknowledgments + +- [Ray](https://www.ray.io/) for the distributed computing framework. +- [Lance](https://lancedb.github.io/lance/) for the columnar storage format. \ No newline at end of file diff --git a/docs/api_reference.md b/docs/api_reference.md new file mode 100644 index 0000000..2780313 --- /dev/null +++ b/docs/api_reference.md @@ -0,0 +1,13 @@ +# API Reference + +## read_lance + +```python +read_lance(path, columns=None, filters=None, storage_options=None, **kwargs) +``` + +## write_lance +```python +write_lance(path, df, schema=None, mode="create", **kwargs) + +``` diff --git a/docs/contributing.md b/docs/contributing.md index fafcf92..a234c7a 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1 +1,21 @@ -# contribution Guidelines +# Contributing + +We welcome contributions from the community! + +## How to Contribute + +1. **Fork** the repository. +2. **Clone** your fork locally. +3. **Create a new branch** for your feature or bugfix. +4. **Make your changes** and add tests if applicable. +5. **Commit** and **push** your changes. +6. **Open a pull request** to the main repository. + +## Guidelines + +- Ensure your code passes all tests before submitting a pull request. +- Write clear and descriptive commit messages. +- Document any new features or changes in the relevant `.md` files. +- Follow the existing code style and conventions. + +Thank you for helping improve Lance-Ray! \ No newline at end of file diff --git a/docs/development.md b/docs/development.md new file mode 100644 index 0000000..dbf0c33 --- /dev/null +++ b/docs/development.md @@ -0,0 +1,23 @@ +# Development + +## Setting Up the Development Environment + +1. **Clone the repository:** + + ```bash + git clone https://github.com//lance-ray.git + cd lance-ray + ``` + +2. **Install dependencies:** + + ```bash + pip install -e .[dev] + ``` + +## Running Tests + +Run all tests using [pytest](https://docs.pytest.org/): + +```bash +pytest \ No newline at end of file diff --git a/docs/examples.md b/docs/examples.md new file mode 100644 index 0000000..3308398 --- /dev/null +++ b/docs/examples.md @@ -0,0 +1,45 @@ +# Examples + +## Basic Usage + +```python + +import ray + +from lance_ray import read_lance, write_lance + +ray.init() + +# Write a DataFrame to Lance +import pandas as pd + +df = pd.DataFrame({"a": [1, 2, 3], "b": ["x", "y", "z"]}) + +write_lance("example.lance", df) + +# Read the dataset back +ds = read_lance("example.lance") + +print(ds.take(3)) + +# Read only specific columns +ds = read_lance("example.lance", columns=["a"]) + +print(ds.take(3)) + +# Read with a filter expression +ds = read_lance("example.lance", filters="a > 1") + +print(ds.take(3)) + +# Process data in parallel using Ray tasks +@ray.remote + +def process_partition(partition): + return [x * 2 for x in partition["a"]] + +partitions = ds.split(2) + +results = ray.get([process_partition.remote(p) for p in partitions]) + +print(results) \ No newline at end of file diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md deleted file mode 100644 index f34d65b..0000000 --- a/docs/getting-started/installation.md +++ /dev/null @@ -1 +0,0 @@ -# Installation \ No newline at end of file diff --git a/docs/getting-started/quick-start.md b/docs/getting-started/quick-start.md deleted file mode 100644 index 2bb9905..0000000 --- a/docs/getting-started/quick-start.md +++ /dev/null @@ -1,17 +0,0 @@ -# Quick Start - -Welcome to the LanceDB + Ray integration quick start guide! - -This guide will show you: -how to Install the required libraries. -how to Create a vector store using LanceDB. -how to Use Ray to scale the processing. - -## Prerequisites - -Ensure you have Python 3.8+ and pip installed. - -## Installation - -```bash -pip install lancedb ray diff --git a/docs/index.md b/docs/index.md index e61a809..4471a48 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,20 +1,36 @@ -# LanceDB + Ray Integration Docs +# Lance-Ray Integration -Welcome to the official documentation for integrating **LanceDB** with **Ray** for scalable vector processing. +A Python library that provides seamless integration between [Ray](https://www.ray.io/) and [Lance](https://lancedb.github.io/lance/) for distributed columnar data processing. -This guide helps you: +## Overview -- Install LanceDB and Ray -- Create and manage vector stores using LanceDB -- Use Ray to scale embedding generation and queries -- Combine the power of Ray with LanceDB for distributed applications +Lance-Ray combines the distributed computing capabilities of Ray with the efficient columnar storage format of Lance, enabling scalable data processing workflows with optimal performance. -## Sections +## Features -- [Getting Started](getting-started/quick-start.md): Setup and basic usage -- [Usage](usage.md): Examples, best practices, and advanced features -- [Contributing](contributing.md): How to contribute to this documentation +- **Distributed Lance Operations:** Leverage Ray’s distributed computing for Lance dataset operations. +- **Seamless Data Movement:** Efficiently move data between Ray and Lance datasets. +- **Optimized I/O:** Fast read and write operations on Lance datasets with Ray integration. +- **Parallel Processing:** Support for concurrent batch operations on distributed Lance data. ---- +## Quick Start -Start by visiting the [Quick Start](getting-started/quick-start.md) guide! +```python + +import ray + +from lance_ray import read_lance, write_lance + +ray.init() + +# Write a pandas DataFrame to Lance format +import pandas as pd + +df = pd.DataFrame({"a": [1, 2, 3], "b": ["x", "y", "z"]}) + +write_lance("example.lance", df) + +# Read the dataset back as a Ray Dataset +ds = read_lance("example.lance") + +print(ds.take(3)) \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 0000000..a54f7e1 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,25 @@ +# Installation + +## Basic Installation + +Install Lance-Ray from PyPI: + +```bash +pip install lance-ray + +# Development Installation + +##Install the latest development version with all dependencies: + +git clone https://github.com//lance-ray.git + +cd lance-ray + +pip install -e .[dev] + +# requirements +Python >= 3.8 + +Ray >= 2.0.0 + +Lance >= 0.2.0 \ No newline at end of file diff --git a/docs/usage.md b/docs/usage.md deleted file mode 100644 index e026544..0000000 --- a/docs/usage.md +++ /dev/null @@ -1 +0,0 @@ -# how to use lance-ray diff --git a/mkdocs.yml b/mkdocs.yml index 0a88042..683afcf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,8 +2,9 @@ site_name: Lance-Ray Documentation nav: - Home: index.md - - Getting Started: - - Installation: getting-started/installation.md - - Quick Start: getting-started/quick-start.md - - Usage: usage.md + - Installation: installation.md + - API Reference: api_reference.md + - Examples: examples.md + - Development: development.md - Contributing: contributing.md + - License: LICENSE.md \ No newline at end of file From 039eea1f8d6610ab7f9b5da813b79d39a165a11f Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Tue, 29 Jul 2025 01:10:04 +0530 Subject: [PATCH 04/14] chore: remove unnecessary LICENSE.md file from docs --- docs/LICENSE.md | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 docs/LICENSE.md diff --git a/docs/LICENSE.md b/docs/LICENSE.md deleted file mode 100644 index 0604f0f..0000000 --- a/docs/LICENSE.md +++ /dev/null @@ -1,9 +0,0 @@ -# License - -This project is licensed under the Apache License 2.0. -See the [LICENSE](../LICENSE) file for full details. - -## Acknowledgments - -- [Ray](https://www.ray.io/) for the distributed computing framework. -- [Lance](https://lancedb.github.io/lance/) for the columnar storage format. \ No newline at end of file From 68f91dc076842b7ae0e39dff40010b230cde5594 Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Tue, 29 Jul 2025 02:34:58 +0530 Subject: [PATCH 05/14] chore(docs): remove api_reference.md as per maintainer's suggestion --- docs/api_reference.md | 13 ------------- 1 file changed, 13 deletions(-) delete mode 100644 docs/api_reference.md diff --git a/docs/api_reference.md b/docs/api_reference.md deleted file mode 100644 index 2780313..0000000 --- a/docs/api_reference.md +++ /dev/null @@ -1,13 +0,0 @@ -# API Reference - -## read_lance - -```python -read_lance(path, columns=None, filters=None, storage_options=None, **kwargs) -``` - -## write_lance -```python -write_lance(path, df, schema=None, mode="create", **kwargs) - -``` From 4ab1f5e3714698b3953ecb96eb06b71724f478ef Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Tue, 29 Jul 2025 15:09:12 +0530 Subject: [PATCH 06/14] docs: finalize documentation updates (contributing, examples, index, quick-start); removed development and installation --- docs/contributing.md | 25 ++++++++++++++++++++++++- docs/development.md | 23 ----------------------- docs/examples.md | 24 ++++++++++++++++++------ docs/index.md | 3 ++- docs/installation.md | 25 ------------------------- docs/quick-start.md | 7 +++++++ 6 files changed, 51 insertions(+), 56 deletions(-) delete mode 100644 docs/development.md delete mode 100644 docs/installation.md create mode 100644 docs/quick-start.md diff --git a/docs/contributing.md b/docs/contributing.md index a234c7a..f1d62e2 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -18,4 +18,27 @@ We welcome contributions from the community! - Document any new features or changes in the relevant `.md` files. - Follow the existing code style and conventions. -Thank you for helping improve Lance-Ray! \ No newline at end of file +## Development setup + +Install the latest development version with all dependencies: + +```bash +git clone https://github.com//lance-ray.git +cd lance-ray +pip install -e .[dev] +``` +# Requirements + +- Python >= 3.8 + +- Ray >= 2.0.0 + +- Lance >= 0.2.0 + +# Running Tests + +To run all tests using [pytest](https://docs.pytest.org/): + +```bash +pytest +``` diff --git a/docs/development.md b/docs/development.md deleted file mode 100644 index dbf0c33..0000000 --- a/docs/development.md +++ /dev/null @@ -1,23 +0,0 @@ -# Development - -## Setting Up the Development Environment - -1. **Clone the repository:** - - ```bash - git clone https://github.com//lance-ray.git - cd lance-ray - ``` - -2. **Install dependencies:** - - ```bash - pip install -e .[dev] - ``` - -## Running Tests - -Run all tests using [pytest](https://docs.pytest.org/): - -```bash -pytest \ No newline at end of file diff --git a/docs/examples.md b/docs/examples.md index 3308398..4a157ed 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -6,40 +6,52 @@ import ray +import pandas as pd + from lance_ray import read_lance, write_lance ray.init() # Write a DataFrame to Lance -import pandas as pd - df = pd.DataFrame({"a": [1, 2, 3], "b": ["x", "y", "z"]}) write_lance("example.lance", df) # Read the dataset back + ds = read_lance("example.lance") print(ds.take(3)) # Read only specific columns + ds = read_lance("example.lance", columns=["a"]) print(ds.take(3)) # Read with a filter expression -ds = read_lance("example.lance", filters="a > 1") -print(ds.take(3)) +filtered_ds = read_lance("example.lance", filters="a > 1") + +print(filtered_ds.take(3)) + +print(f"Filtered count: {filtered_ds.count()}") + +## Advanced Usage # Process data in parallel using Ray tasks @ray.remote - def process_partition(partition): return [x * 2 for x in partition["a"]] +# Split the dataset into 2 partitions + +ds = read_lance("example.lance") + partitions = ds.split(2) +# Process each partition in parallel results = ray.get([process_partition.remote(p) for p in partitions]) -print(results) \ No newline at end of file +print(results) +``` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 4471a48..fd3f2ff 100644 --- a/docs/index.md +++ b/docs/index.md @@ -33,4 +33,5 @@ write_lance("example.lance", df) # Read the dataset back as a Ray Dataset ds = read_lance("example.lance") -print(ds.take(3)) \ No newline at end of file +print(ds.take(3)) +``` diff --git a/docs/installation.md b/docs/installation.md deleted file mode 100644 index a54f7e1..0000000 --- a/docs/installation.md +++ /dev/null @@ -1,25 +0,0 @@ -# Installation - -## Basic Installation - -Install Lance-Ray from PyPI: - -```bash -pip install lance-ray - -# Development Installation - -##Install the latest development version with all dependencies: - -git clone https://github.com//lance-ray.git - -cd lance-ray - -pip install -e .[dev] - -# requirements -Python >= 3.8 - -Ray >= 2.0.0 - -Lance >= 0.2.0 \ No newline at end of file diff --git a/docs/quick-start.md b/docs/quick-start.md new file mode 100644 index 0000000..f61823c --- /dev/null +++ b/docs/quick-start.md @@ -0,0 +1,7 @@ +# Quick Start + +Install Lance-Ray using pip: + +```bash +pip install lance-ray +``` From 895c643b269e5435c79ec4fec2b4021849415a93 Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Tue, 29 Jul 2025 15:13:56 +0530 Subject: [PATCH 07/14] chore: add myenv/ to .gitignore to avoid committing virtual environment --- .gitignore | Bin 4688 -> 4911 bytes 1 file changed, 0 insertions(+), 0 deletions(-) diff --git a/.gitignore b/.gitignore index b7faf403d915ca307532bb0eb9cceaf0214e8e5b..a7de7d8b56faad627fa30bb7e4a4d9d65ef05175 100644 GIT binary patch delta 1908 zcmZ8i&u<(x6y7vRn+|b)s49&}DJv0L6trF>P{of^8WI{%qHUA52t+5dGu~Y%v$i|- zZgwg}{{>*q9Fe#n3KD0oh*Kr5+&FMX;)n#_^UQ7{F1Fu$-+O-c`~3WD?fdIr+}L12 z7@9ne;+_b@CJWZN$v=s8^7vD%*G$giG_sZjEO@!TSr;QGl$BaRv(BxC{>#JFCoJHt z-1W3#L3<$61aT5E6sa~1(d}9irFAsv6P4;HAysAJ)tt&Ulo)TmiP=P%Bap2ehfxOU zq$fn`)x9VaP2=}$oNSNP>lCaZRYwENrLrzcQ<3nv)1`c2WWnyn-p=;c{y}-9R=!iA zGFH4cwLQg(M^mkvgziU5c7%2Qq(;Q0!vtPWbr-i_q-kKq-N>=xuc>R(fE7#UUc#O9 zTtAKVkWz7aM3X8fC`A@^1vKL&Unha8zyhVMaM;-LQ9otD1mdOj(uIjkL8tQ$S#UN~MaNMZ zA}c3V*CIYD+2;09DxG+P6;sofa9ncV23d|L-o5}T7L?P8XoE+>*+z9rg73#!Wbz4~ zTQ8TP_DxT!Q9aS|pf8m3854nG+YHAfqZqCH7AW^5@%LbIZxTcn7iC>Rq$AV^1GuD=F~ZE~T` z4O#Ke^gYn$&dlvPX{ibTH&7sYFl8EGi%@|6G;;{(U3Bo{v{-YULkmr%*4>|>0_D0GZ{%`CGX8aW;Gi8-0}m&43}xApO@b@fW_VtU(+onvH3} zMM0u|V@FbuwB}_VlblUhDOJdd!hi-*u*y?WN;=KK(%Pf;Q}Q$>u-w~-iK5zq-?SkU zs$+6GVyr~lh-wxqzfag1*D*)P#Zbm1;=)*3mMo95VF70b7ukEbzq`G4_ykYiZ+3;5 z@eu8Hu57!nuJk_vTtx*RGGp+y|g?fBU_c3oWPl^JcCvE6)a5Cf|00`qIHn56+}n_8I3j3Syhq?KPu}j9KP5e z%t4}2qof@%!=W%>#>m7ciXnCikQi_AL{ni(irvBpOWuMIi%Y>*4SLnBjJ$ zlo>4(IERIn8c0j>G%}x;+_LvCiQ$Q?wV)-Y*#^3dyDYx`B4c;qOs6abA~9>i_I`jp z%rsR^2ab$aiTnQQYf~UcX5!?WJ%H^ukB~`tRn>SiUdd8jFrX3uKCbcBI@p(%rBaTe z`>GLX0=3M>N^)U6i+9g?sk9vOk|jAC(z=8cfJVY5nG{1lU*KgSt7@2-xX0I?x*x9X z+y(>I7GNP%6kmeJaD|}W^?_6H`|J9#dvE5>D`ch5748A0%*F_OdgQ8^f%|>t*oCvJ zx5!F8x$r5;tZu-+<$ju7?lA80%gNhhrFFL0PO%c0fG5l=ANA(kZFhfe;J%$Z*no(< z>fj)GYy`HjJw4PA%>yllvL8cr-4uSW3)Q(_gXv6XVE9K`3*w2f=;Q8DaY z1U1HGI?)-4CaA$LCMd;ZYySv_h?qnv9k;et!i`h|v*X}JwIcm{~0qR^50o!jh3v2_s zdd9Xyhxz7v+;|5}Aj{qJ`Q8J31ZZlD?-?27EUk;cG*v1~L$a35-sn;NW)tRR<$j$1 z^eSxUPHsMOy9>A6i-phJuM5XZWF_J`qaOP(g{e;6-QIo2dVB7d-r6#Ws5g555jQn0 zgF{>ATn3vmXYQZgz#ZQlLAsCJ!s6?0ZE@#a*e047_%CVCc>t5;;<0N`x}v!67T;LH zD=7}Wg{aM18>!uIi_hGhrGfi$>4OCri{8i!AvJS1@di!b!j Ms2Kj Date: Tue, 29 Jul 2025 15:29:04 +0530 Subject: [PATCH 08/14] docs: update mkdocs.yml to match finalized documentation structure --- mkdocs.yml | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 683afcf..8029454 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,9 +2,7 @@ site_name: Lance-Ray Documentation nav: - Home: index.md - - Installation: installation.md - - API Reference: api_reference.md + - Quick Start: quick-start.md - Examples: examples.md - - Development: development.md - Contributing: contributing.md - - License: LICENSE.md \ No newline at end of file + \ No newline at end of file From 6e7a0832445388fd915bdfcf14dfdd5f908f7869 Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Wed, 30 Jul 2025 23:30:38 +0530 Subject: [PATCH 09/14] chore: revert README.md change per review --- README.md | 41 +++-------------------------------------- 1 file changed, 3 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 1c528dd..911f192 100644 --- a/README.md +++ b/README.md @@ -16,51 +16,16 @@ Lance-Ray combines the distributed computing capabilities of Ray with the effici ## Installation -### Basic Installation ```bash -# Clone the repository -git clone https://github.com/lancedb/lance-ray.git +# Install from source +git clone https://github.com/lance-ray/lance-ray.git cd lance-ray - -### Install UV (if not already installed) - -```bash -pip install uv - -# if 'uv' command is not recognized (especially on windows) -python -m uv pip install -e . - -# Install in editable mode uv pip install -e . -``` - -### Development Installation (with all dependencies) -```bash -# Clone the repository -git clone https://github.com/lancedb/lance-ray.git -cd lance-ray - -# Install UV (if not already installed) -pip install uv - -# Install with development dependencies +# Or install with development dependencies uv pip install -e ".[dev]" ``` -### Windows Specific Instructions -```bash -# If 'uv' command is still not recognized (especially on Windows), -# try restarting your terminal or use: -# Basic installation -python -m uv pip install -e . - -# Development installation -python -m uv pip install -e ".[dev]" - -``` - - ## Requirements - Python >= 3.10 From e9e5ea369f9b65a41b877e1865ea1106e51a0fb5 Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Sun, 3 Aug 2025 22:06:00 +0530 Subject: [PATCH 10/14] docs: update contribute.md for lance-ray standards --- docs/contributing.md | 20 +------------------- 1 file changed, 1 insertion(+), 19 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index f1d62e2..75c64a6 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,22 +1,4 @@ -# Contributing - -We welcome contributions from the community! - -## How to Contribute - -1. **Fork** the repository. -2. **Clone** your fork locally. -3. **Create a new branch** for your feature or bugfix. -4. **Make your changes** and add tests if applicable. -5. **Commit** and **push** your changes. -6. **Open a pull request** to the main repository. - -## Guidelines - -- Ensure your code passes all tests before submitting a pull request. -- Write clear and descriptive commit messages. -- Document any new features or changes in the relevant `.md` files. -- Follow the existing code style and conventions. +# Contributing to lance-ray ## Development setup From 51f617926ae7220c03ab275abda55e1a2456f9d9 Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Sun, 3 Aug 2025 22:18:10 +0530 Subject: [PATCH 11/14] docs: remove quick-start.md as suggested in review --- docs/quick-start.md | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 docs/quick-start.md diff --git a/docs/quick-start.md b/docs/quick-start.md deleted file mode 100644 index f61823c..0000000 --- a/docs/quick-start.md +++ /dev/null @@ -1,7 +0,0 @@ -# Quick Start - -Install Lance-Ray using pip: - -```bash -pip install lance-ray -``` From e0a910d6e86d4f1f4c317281e3fab22bb22511dd Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Sun, 3 Aug 2025 22:21:27 +0530 Subject: [PATCH 12/14] docs: minor fix in contributing.md --- docs/contributing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing.md b/docs/contributing.md index 75c64a6..8e04b2b 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -7,7 +7,7 @@ Install the latest development version with all dependencies: ```bash git clone https://github.com//lance-ray.git cd lance-ray -pip install -e .[dev] +uv pip install -e .[dev] ``` # Requirements @@ -22,5 +22,5 @@ pip install -e .[dev] To run all tests using [pytest](https://docs.pytest.org/): ```bash -pytest +uv run pytest ``` From bd9a80ce32d39b4ba0a52608db6c4809de22948a Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Sat, 9 Aug 2025 23:16:30 +0530 Subject: [PATCH 13/14] Restore .gitignore and tighten dependencies in contributing.md --- .gitignore | 10 ++++++++++ docs/contributing.md | 13 +++++++++++-- 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 0e3919d..3e02d64 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,15 @@ __pycache__/ *.py[cod] +*.py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ + .env .venv/ .DS_Store diff --git a/docs/contributing.md b/docs/contributing.md index 8e04b2b..8cee482 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -13,9 +13,18 @@ uv pip install -e .[dev] - Python >= 3.8 -- Ray >= 2.0.0 +- Ray >= 2.40.0 + +- PyLance >= 0.30.0 + +- lance-namespace >= 0.0.5 + +- PyArrow >= 17.0.0 + +- Pandas >= 2.2.0 + +- NumPy >= 2.0.0 -- Lance >= 0.2.0 # Running Tests From bab2bd460157bde98272a508d793e982205b1c63 Mon Sep 17 00:00:00 2001 From: Gurukiran20 Date: Fri, 15 Aug 2025 23:42:18 +0530 Subject: [PATCH 14/14] docs: update theme color to indigo, add GitHub logo favicon, fix Quickstart.md, add social links --- mkdocs.yml | 49 ++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 46 insertions(+), 3 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index 8029454..eb5c2ea 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,51 @@ -site_name: Lance-Ray Documentation +site_name: Lance-Ray +strict: true +docs_dir: docs + +repo_name: lancedb/lance-ray +repo_url: https://github.com/lancedb/lance-ray + +theme: + name: material + logo: images/lance-logo.png + favicon: images/lance-favicon.png + palette: + - scheme: default + primary: indigo + accent: indigo + toggle: + icon: material/brightness-7 + name: Switch to dark mode + - scheme: slate + primary: indigo + accent: indigo + toggle: + icon: material/brightness-4 + name: Switch to light mode + features: + - navigation.sections + - navigation.expand + - navigation.top + - search.highlight + - search.share + - content.code.copy + - content.code.annotate + + icon: + repo: fontawesome/brands/github nav: - Home: index.md - - Quick Start: quick-start.md - Examples: examples.md - Contributing: contributing.md - \ No newline at end of file + +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/lancedb/lance-ray + - icon: fontawesome/brands/discord + link: https://discord.gg/zMM32dvNtd + - icon: fontawesome/brands/x-twitter + link: https://twitter.com/lancedb + footer: + social: true \ No newline at end of file