openadapt-retrieval/pyproject.toml at main · OpenAdaptAI/openadapt-retrieval · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"

[project]
name = "openadapt-retrieval"
version = "0.1.2"
description = "Multimodal demo retrieval using VLM embeddings for GUI automation"
readme = "README.md"
requires-python = ">=3.10"
license = "MIT"
authors = [
    {name = "Richard Abrich", email = "richard@openadapt.ai"}
]
maintainers = [
    {name = "OpenAdaptAI", email = "info@openadapt.ai"}
]
keywords = ["retrieval", "embeddings", "multimodal", "vlm", "gui", "automation", "faiss"]
classifiers = [
    "Development Status :: 3 - Alpha",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Topic :: Software Development :: Libraries :: Python Modules",
]

dependencies = [
    "torch>=2.0.0",
    "transformers>=4.40.0",
    "pillow>=10.0.0",
    "faiss-cpu>=1.7.4",
    "numpy>=1.24.0",
    "tqdm>=4.65.0",
    "pydantic>=2.0.0",
]

[project.optional-dependencies]
dev = [
    "pytest>=8.0.0",
    # Bounded on purpose. `ruff>=0.1.0` unpinned means `ruff check` here answers
    # differently depending on the day it is run: ruff 0.16.0 grew its DEFAULT
    # rule set from 59 rules to 413, and this project selected no rules
    # explicitly, so it silently inherited 354 new ones. This tree reported 0
    # findings under ruff 0.14 and 103 under 0.16. Raise the ceiling
    # deliberately, with the findings cleared in the same change.
    "ruff>=0.16,<0.17",
]
gpu = [
    # For GPU-accelerated inference
    "accelerate>=0.26.0",
]
clip = [
    # CLIP fallback embedder
    "open-clip-torch>=2.24.0",
]
serve = [
    # HTTP API serving
    "fastapi>=0.109.0",
    "uvicorn>=0.27.0",
]
all = [
    "openadapt-retrieval[dev,gpu,clip,serve]",
]

[project.scripts]
openadapt-retrieval = "openadapt_retrieval.cli:main"

[project.urls]
Homepage = "https://github.com/OpenAdaptAI/openadapt-retrieval"
Repository = "https://github.com/OpenAdaptAI/openadapt-retrieval"
Documentation = "https://github.com/OpenAdaptAI/openadapt-retrieval#readme"
Issues = "https://github.com/OpenAdaptAI/openadapt-retrieval/issues"
Changelog = "https://github.com/OpenAdaptAI/openadapt-retrieval/releases"

[tool.hatch.build.targets.wheel]
packages = ["src/openadapt_retrieval"]

[tool.ruff]
line-length = 100
target-version = "py310"

# There is deliberately no `select` here. After the fixes in this change the
# package clears the whole ruff 0.16 default set (413 rules), so narrowing it to
# a handful of prefixes would discard coverage it is earning today -- including
# the S110 rule that surfaced the silently-dropped FAISS reconstruction below.
# Predictability comes from the bounded `ruff>=0.16,<0.17` in the dev extra
# above: ruff only grows its default set in a minor release, so the rule set
# cannot move until a person raises that ceiling and owns the new findings in
# the same change.

[tool.ruff.lint.per-file-ignores]
# RUF022 wants `__all__` sorted alphabetically. This package's `__all__` is
# grouped by subsystem with `# Embedders` / `# Retriever` / `# Storage`
# headings, and an alphabetical sort strands all three comments against
# unrelated names. The grouping documents the package layout and is worth more
# than the ordering, so the rule is turned off for this one file rather than
# repo-wide.
"src/openadapt_retrieval/__init__.py" = ["RUF022"]

[tool.pytest.ini_options]
markers = [
    "gpu: marks tests as requiring GPU (deselect with '-m \"not gpu\"')",
    "slow: marks tests as slow (deselect with '-m \"not slow\"')",
]

[tool.semantic_release]
version_toml = ["pyproject.toml:project.version"]
commit_message = "chore: release {version}"

[tool.semantic_release.branches.main]
match = "main"

[tool.semantic_release.commit_parser_options]
allowed_tags = ["build", "chore", "ci", "docs", "feat", "fix", "perf", "refactor", "style", "test"]
minor_tags = ["feat"]
patch_tags = ["fix", "perf"]