mirror of
https://github.com/zylon-ai/private-gpt.git
synced 2025-12-22 07:40:12 +01:00
64c5ae214a
* Configure simple builtin logging Changed the 2 existing `print` in the `private_gpt` code base into actual python logging, stop using loguru (dependency will be dropped in a later commit). Try to use the `key=value` logging convention in logs (to indicate what dynamic values represents, and what is dynamic vs not). Using `%s` log style, so that the string formatting is pushed inside the logger, giving the ability to the logger to determine if the string need to be formatted or not (i.e. strings from debug logs might not be formatted if the log level is not debug) The (basic) builtin log configuration have been placed in `private_gpt/__init__.py` in order to initialize the logging system even before we start to launch any python code in `private_gpt` package (ensuring we get any initialization log formatted as we want to) Disabled `uvicorn` custom logging format, resulting in having uvicorn logs being outputted in our formatted. Some more concise format could be used if we want to, especially: ``` COMPACT_LOG_FORMAT = '%(asctime)s.%(msecs)03d [%(levelname)s] %(name)s - %(message)s' ``` Python documentation and cookbook on logging for reference: * https://docs.python.org/3/library/logging.html * https://docs.python.org/3/howto/logging.html * Removing loguru from the dependencies Result of `poetry remove loguru` * PR feedback: using `logger` variable name instead of `log` --------- Co-authored-by: Louis Melchior <louis@jaris.io>
141 lines
No EOL
3.2 KiB
TOML
141 lines
No EOL
3.2 KiB
TOML
[tool.poetry]
|
|
name = "private-gpt"
|
|
version = "0.1.0"
|
|
description = "Private GPT"
|
|
authors = ["Zylon <hi@zylon.ai>"]
|
|
|
|
[tool.poetry.dependencies]
|
|
python = ">=3.11,<3.12"
|
|
fastapi = { extras = ["all"], version = "^0.103.1" }
|
|
boto3 = "^1.28.56"
|
|
injector = "^0.21.0"
|
|
pyyaml = "^6.0.1"
|
|
python-multipart = "^0.0.6"
|
|
pypdf = "^3.16.2"
|
|
llama-index = "0.8.47"
|
|
chromadb = "^0.4.13"
|
|
watchdog = "^3.0.0"
|
|
transformers = "^4.34.0"
|
|
# https://stackoverflow.com/questions/76327419/valueerror-libcublas-so-0-9-not-found-in-the-system-path
|
|
torch = ">=2.0.0, !=2.0.1, !=2.1.0"
|
|
|
|
[tool.poetry.group.dev.dependencies]
|
|
black = "^22"
|
|
mypy = "^1.2"
|
|
pre-commit = "^2"
|
|
pytest = "^7"
|
|
pytest-cov = "^3"
|
|
ruff = "^0"
|
|
pytest-asyncio = "^0.21.1"
|
|
types-pyyaml = "^6.0.12.12"
|
|
|
|
# Dependencies for gradio UI
|
|
[tool.poetry.group.ui]
|
|
optional = true
|
|
[tool.poetry.group.ui.dependencies]
|
|
gradio = "^3.45.2"
|
|
|
|
[tool.poetry.group.local]
|
|
optional = true
|
|
[tool.poetry.group.local.dependencies]
|
|
sentence-transformers = "^2.2.2"
|
|
numpy = "1.26.0"
|
|
llama-cpp-python = "^0.2.11"
|
|
|
|
[build-system]
|
|
requires = ["poetry-core>=1.0.0"]
|
|
build-backend = "poetry.core.masonry.api"
|
|
|
|
# Packages configs
|
|
|
|
## coverage
|
|
|
|
[tool.coverage.run]
|
|
branch = true
|
|
|
|
[tool.coverage.report]
|
|
skip_empty = true
|
|
precision = 2
|
|
|
|
## black
|
|
|
|
[tool.black]
|
|
target-version = ['py311']
|
|
|
|
## ruff
|
|
# Recommended ruff config for now, to be updated as we go along.
|
|
[tool.ruff]
|
|
target-version = 'py311'
|
|
|
|
# See all rules at https://beta.ruff.rs/docs/rules/
|
|
select = [
|
|
"E", # pycodestyle
|
|
"W", # pycodestyle
|
|
"F", # Pyflakes
|
|
"B", # flake8-bugbear
|
|
"C4", # flake8-comprehensions
|
|
"D", # pydocstyle
|
|
"I", # isort
|
|
"SIM", # flake8-simplify
|
|
"TCH", # flake8-type-checking
|
|
"TID", # flake8-tidy-imports
|
|
"Q", # flake8-quotes
|
|
"UP", # pyupgrade
|
|
"PT", # flake8-pytest-style
|
|
"RUF", # Ruff-specific rules
|
|
]
|
|
|
|
ignore = [
|
|
"E501", # "Line too long"
|
|
# -> line length already regulated by black
|
|
"PT011", # "pytest.raises() should specify expected exception"
|
|
# -> would imply to update tests every time you update exception message
|
|
"SIM102", # "Use a single `if` statement instead of nested `if` statements"
|
|
# -> too restrictive,
|
|
"D100",
|
|
"D101",
|
|
"D102",
|
|
"D103",
|
|
"D104",
|
|
"D105",
|
|
"D106",
|
|
"D107"
|
|
# -> "Missing docstring in public function too restrictive"
|
|
]
|
|
|
|
[tool.ruff.pydocstyle]
|
|
# Automatically disable rules that are incompatible with Google docstring convention
|
|
convention = "google"
|
|
|
|
[tool.ruff.pycodestyle]
|
|
max-doc-length = 88
|
|
|
|
[tool.ruff.flake8-tidy-imports]
|
|
ban-relative-imports = "all"
|
|
|
|
[tool.ruff.flake8-type-checking]
|
|
strict = true
|
|
runtime-evaluated-base-classes = ["pydantic.BaseModel"]
|
|
# Pydantic needs to be able to evaluate types at runtime
|
|
# see https://pypi.org/project/flake8-type-checking/ for flake8-type-checking documentation
|
|
# see https://beta.ruff.rs/docs/settings/#flake8-type-checking-runtime-evaluated-base-classes for ruff documentation
|
|
|
|
[tool.ruff.per-file-ignores]
|
|
# Allow missing docstrings for tests
|
|
"tests/**/*.py" = ["D1"]
|
|
|
|
## mypy
|
|
|
|
[tool.mypy]
|
|
python_version = "3.11"
|
|
strict = true
|
|
check_untyped_defs = false
|
|
explicit_package_bases = true
|
|
exclude = ["tests"]
|
|
|
|
[tool.pytest.ini_options]
|
|
asyncio_mode = "auto"
|
|
testpaths = ["tests"]
|
|
addopts = [
|
|
"--import-mode=importlib",
|
|
] |