upd README and fix bugs

This commit is contained in:
tianyufan
2025-02-27 15:36:31 +08:00
parent 7bdfac26fb
commit 20fbf07f0a
6 changed files with 37 additions and 6 deletions

3
MANIFEST.in Normal file
View File

@@ -0,0 +1,3 @@
include README.md
include requirements.txt
include minirag/api/requirements.txt" > MANIFEST.in

View File

@@ -19,6 +19,7 @@ The Code Repository: **MiniRAG: Towards Extremely Simple Retrieval-Augmented Gen
## 🎉 News
- [x] [2025.02.27]🎯📢Now you can use `pip install minirag-hku` to run our code!
- [x] [2025.02.14]🎯📢Now MiniRAG supports 10+ heterogeneous graph databases, including Neo4j, PostgreSQL, TiDB, etc. Happy valentine's day!🌹🌹🌹
- [x] [2025.02.05]🎯📢Our team has released [VideoRAG](https://github.com/HKUDS/VideoRAG) understanding extremely long-context videos.
- [x] [2025.02.01]🎯📢Now MiniRAG supports API&Docker deployment. see [This](./minirag/api/README.md) for more details.

View File

@@ -15,6 +15,7 @@
## 🎉 News
- [x] [2025.02.27]🎯📢现在您可以使用 `pip install minirag-hku` 来运行我们的代码!
- [x] [2025.02.14]🎯📢现在MiniRAG支持包括Neo4j、PostgreSQL、TiDB等在内的10多种异构图数据库。情人节快乐🌹🌹🌹
- [x] [2025.02.05]🎯📢我们的团队发布了[VideoRAG](https://github.com/HKUDS/VideoRAG),能够理解极长上下文视频。
- [x] [2025.02.01]🎯📢现在MiniRAG支持API和Docker部署。更多详情请参见[这里](./minirag/api/README.md)。

View File

@@ -17,6 +17,7 @@
[English](./README.md) | [中文](./README_CN.md)
## 🎉 News
- [x] [2025.02.27]🎯📢`pip install minirag-hku`を使用して私たちのコードを実行できるようになりました!
- [x] [2025.02.14]🎯📢MiniRAGがNeo4j、PostgreSQL、TiDBなど10以上の異種グラフデータベースをサポートするようになりました。バレンタインデーおめでとう🌹🌹🌹
- [x] [2025.02.05]🎯📢私たちのチームは、非常に長いコンテキストの動画を理解するVideoRAGをリリースしました。
- [x] [2025.02.01]🎯📢MiniRAGがAPI&Dockerデプロイメントをサポートするようになりました。詳細はこちらをご覧ください。

24
pyproject.toml Normal file
View File

@@ -0,0 +1,24 @@
[build-system]
requires = ["setuptools>=45", "wheel"]
build-backend = "setuptools.build_meta"
[project]
name = "minirag-hku"
version = "0.0.2"
authors = [
{name = "Tianyu Fan"},
]
description = "MiniRAG: Towards Extremely Simple Retrieval-Augmented Generation"
readme = "README.md"
requires-python = ">=3.9"
classifiers = [
"Development Status :: 4 - Beta",
"Programming Language :: Python :: 3",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Intended Audience :: Developers",
"Topic :: Software Development :: Libraries :: Python Modules",
]
[tool.setuptools]
packages = ["minirag"]

View File

@@ -36,17 +36,18 @@ def read_api_requirements():
long_description = read_long_description()
requirements = read_requirements()
setuptools.setup(
name="minirag-hku",
url="https://github.com/HKUDS/MiniRAG",
version="0.0.2",
author="HKUDS",
author="Tianyu Fan",
description="MiniRAG: Towards Extremely Simple Retrieval-Augmented Generation",
long_description=long_description,
long_description_content_type="text/markdown",
packages=setuptools.find_packages(
exclude=("tests*", "docs*")
), # Automatically find packages
),
classifiers=[
"Development Status :: 4 - Beta",
"Programming Language :: Python :: 3",
@@ -55,15 +56,15 @@ setuptools.setup(
"Intended Audience :: Developers",
"Topic :: Software Development :: Libraries :: Python Modules",
],
python_requires=">=3.9", # rec: 3.9.19
python_requires=">=3.9",
install_requires=requirements,
include_package_data=True, # Includes non-code files from MANIFEST.in
include_package_data=True,
extras_require={
"api": read_api_requirements(), # API requirements as optional
"api": read_api_requirements(),
},
entry_points={
"console_scripts": [
"minirag-server=minirag.api.minirag_server:main [api]",
],
},
)
)