Skip to content

Commit

Permalink
[Feature] Column comment (#2038)
Browse files Browse the repository at this point in the history
### What problem does this PR solve?

Column comment

### Type of change

- [x] New Feature (non-breaking change which adds functionality)

---------

Signed-off-by: Jin Hai <[email protected]>
Co-authored-by: shenyushi <[email protected]>
  • Loading branch information
JinHai-CN and small-turtle-1 authored Oct 14, 2024
1 parent 0101f65 commit 1e0ac82
Show file tree
Hide file tree
Showing 45 changed files with 3,822 additions and 3,465 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Supports a wide range of data types including strings, numerics, vectors, and mo
Infinity supports two working modes, embedded mode and client-server mode. Infinity's embedded mode enables you to quickly embed Infinity into your Python applications, without the need to connect to a separate backend server. The following shows how to operate in embedded mode:

```bash
pip install infinity-embedded-sdk==0.4.0.dev3
pip install infinity-embedded-sdk==0.4.0.dev4
```
1. Use Infinity to conduct a dense vector search:
```python
Expand Down
2 changes: 1 addition & 1 deletion benchmark/remote_infinity/remote_query_benchmark.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ struct InfinityClient {
transport->open();
CommonResponse response;
ConnectRequest request;
request.__set_client_version(20); // 0.4.0-dev3
request.__set_client_version(21); // 0.4.0.dev4
client->Connect(response, request);
session_id = response.session_id;
}
Expand Down
2 changes: 1 addition & 1 deletion client/cpp/infinity_client.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Client Client::Connect(const std::string &ip_address, uint16_t port) {
transport->open();
CommonResponse response;
ConnectRequest request;
request.__set_client_version(20); // 0.4.0.dev3
request.__set_client_version(21); // 0.4.0.dev4
client->Connect(response, request);
return {socket, transport, protocol, std::move(client), response.session_id};
}
Expand Down
6 changes: 3 additions & 3 deletions docs/getstarted/build_from_source.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ cmake --build . -t test_main

2. Install Python sdk of infinity:
```bash
pip install infinity-sdk==0.4.0.dev3
pip install infinity-sdk==0.4.0.dev4
```

3. Run the functional tests:
Expand All @@ -282,7 +282,7 @@ cmake --build . -t test_main

2. Install Python sdk of infinity:
```bash
pip install infinity-sdk==0.4.0.dev3
pip install infinity-sdk==0.4.0.dev4
```

3. Run the functional tests:
Expand All @@ -305,7 +305,7 @@ cmake --build . -t test_main

2. Install Python sdk of infinity:
```bash
pip install infinity-sdk==0.4.0.dev3
pip install infinity-sdk==0.4.0.dev4
```

3. Run the functional tests:
Expand Down
10 changes: 5 additions & 5 deletions docs/getstarted/deploy_infinity_server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This approach allows you to call Infinity as a Python module. To deploy Infinity
### Install Infinity as a module

```
pip install infinity-embedded-sdk==0.4.0.dev3
pip install infinity-embedded-sdk==0.4.0.dev4
```

### Create an Infinity object
Expand Down Expand Up @@ -98,7 +98,7 @@ If you are on Windows 10+, you must enable WSL or WSL2 to deploy Infinity using
### Install Infinity client

```
pip install infinity-sdk==0.4.0.dev3
pip install infinity-sdk==0.4.0.dev4
```

### Connect to Infinity Server and run a dense vector search
Expand Down Expand Up @@ -148,7 +148,7 @@ This section provides instructions on deploying Infinity using binary package on

Fedora/RHEL/CentOS/OpenSUSE
```bash
sudo rpm -i infinity-0.4.0.dev3-x86_64.rpm
sudo rpm -i infinity-0.4.0.dev4-x86_64.rpm
```

```bash
Expand All @@ -159,7 +159,7 @@ sudo systemctl start infinity
<TabItem value="ubuntu">

```bash
sudo dpkg -i infinity-0.4.0.dev3-x86_64.deb
sudo dpkg -i infinity-0.4.0.dev4-x86_64.deb
```

```bash
Expand All @@ -172,7 +172,7 @@ sudo systemctl start infinity
### Install Infinity client

```
pip install infinity-sdk==0.4.0.dev3
pip install infinity-sdk==0.4.0.dev4
```

### Connect to Infinity Server and run a dense vector search
Expand Down
2 changes: 1 addition & 1 deletion docs/getstarted/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ If you wish to embed Infinity into your Python application without the need for

1. Install the Infinity-embedded SDK:
```bash
pip install infinity-embedded-sdk==0.4.0.dev3
pip install infinity-embedded-sdk==0.4.0.dev4
```
2. Use Infinity to conduct a dense vector search:
```python
Expand Down
6 changes: 3 additions & 3 deletions docs/references/pysdk_api_reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ The `uri` here can be either a local directory in `str` format or a `NetworkAddr

:::tip IMPORTANT
- When setting `uri` as `"/absolute/path/to/save/to"`, ensure you:
- Install the embedded SDK: `pip install infinity-embedded-sdk==<v0.4.0.dev3_OR_HIGHER>`
- Install the embedded SDK: `pip install infinity-embedded-sdk==<v0.4.0.dev4_OR_HIGHER>`
- Import the `infinity_embedded` module: `import infinity_embedded`.
- When setting `uri` as `NetworkAddress`, ensure you:
- Install the Infinity SDK: `pip install infinity==<VERSION>`
Expand All @@ -54,7 +54,7 @@ When connecting to Infinity in client-server mode, ensure that the client versio
| v0.2.0 | v0.2.0 |
| v0.2.1 | v0.2.1 |
| v0.3.0 | v0.3.0 |
| v0.4.0.dev3 | v0.4.0.dev3 |
| v0.4.0.dev4 | v0.4.0.dev4 |

If the versions do not match, please update your client or server to ensure compatibility.

Expand Down Expand Up @@ -83,7 +83,7 @@ This allows for bug fixes without requiring changes to the configuration file.

#### Connect to the local directory of Infinity

From v0.4.0.dev3 onwards, Infinity also gives you the option to connect to the Infinity service just like calling a Python module. If you have installed the Infinity client via `pip install infinity-embedded-sdk==<v0.4.0.dev3_OR_HIGHER>`, you can connect to Infinity and save all related data in a local directory:
From v0.4.0.dev4 onwards, Infinity also gives you the option to connect to the Infinity service just like calling a Python module. If you have installed the Infinity client via `pip install infinity-embedded-sdk==<v0.4.0.dev4_OR_HIGHER>`, you can connect to Infinity and save all related data in a local directory:

```python
import infinity_embedded
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ build-backend = "scikit_build_core.build"

[project]
name = "infinity_embedded_sdk"
version = "0.4.0.dev3"
version = "0.4.0.dev4"
requires-python = ">=3.10"
dependencies = [
"sqlglot~=11.7.0",
Expand Down
Loading

0 comments on commit 1e0ac82

Please sign in to comment.