Skip to content

Commit dd3c65a

Browse files
committed
docs: README.md updates and initial CHANGELOG.md #45
1 parent ba5225e commit dd3c65a

File tree

2 files changed

+32
-1
lines changed

2 files changed

+32
-1
lines changed

CHANGELOG.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
ObjectBox Python ChangeLog
2+
==========================
3+
4+
4.0.0 (2024-05-16)
5+
------------------
6+
7+
### Core
8+
9+
* ObjectBox now supports vector search ("vector database") to enable efficient similarity searches.
10+
This is particularly useful for AI/ML/RAG applications, e.g. image, audio, or text similarity.
11+
Other use cases include sematic search or recommendation engines.
12+
See https://docs.objectbox.io/ann-vector-search for details.
13+
* Adjusting the version number to match the core version (4.0); we will be aligning on major versions from now on.
14+
15+
### Python Bindings
16+
17+
* Queries: Support for Property-based conditions and logic combinations
18+
* Convenient "Store" API deprecates ObjectBox and Builder API
19+
* New examples added, illustrating an VectorSearch and AI/RAG application
20+
* Dependency flatbuffers: Updated to 24.3.50
21+
22+
0.6.1 (and below)
23+
-----------------
24+
25+
Please check https://github.com/objectbox/objectbox-python/releases for details.

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@ ObjectBox Python API
22
====================
33
[ObjectBox](https://objectbox.io) is a superfast database for objects, now also available for Python (3.4+) with a simple CRUD API.
44
And because it's an embedded database, there's no setup required.
5-
5+
6+
Its advanced vector search empowers AI for a variety of applications, including RAG AI, generative AI,
7+
and similarity searches. Designed for high performance, the ObjectBox database is excellent for mobile and IoT devices,
8+
minimizing CPU, memory, and battery usage to enhance device efficiency and sustainability.
9+
As an offline-first solution, ObjectBox makes sure your app reliably works offline as well as online.
10+
11+
612
## Table of Contents:
713
- [Getting Started](#getting-started)
814
- [Model IDs and UIDs](#model-ids-and-uids)

0 commit comments

Comments
 (0)