SciPhi-AI / R2R

The Elasticsearch for RAG. Build, scale, and deploy state of the art Retrieval-Augmented Generation applications
https://r2r-docs.sciphi.ai/
MIT License
3.25k stars 237 forks source link

Configuration option `logging.logging_path` is undocumented #920

Open aphedges opened 3 weeks ago

aphedges commented 3 weeks ago

There is a logging.logging_path setting for the local logging provider:

https://github.com/SciPhi-AI/R2R/blob/210e11249c2695993be4ddf8433b30f42894d02c/r2r/base/logging/kv_logger.py#L29

However, it is not documented at https://r2r-docs.sciphi.ai/deep-dive/main/config#logging. It should be added to the documentation.

On a related note, are the docs available for editing anywhere? I would love to just contribute a PR for something minor like this.

emrgnt-cmplxty commented 3 weeks ago

We can work on making the docs publicly accessible after the v3 release in the coming days. They have been heavily refactored for clarity after our recent period of feature expansion, hopefully this will address some of your concerns.

aphedges commented 3 weeks ago

They have been heavily refactored for clarity after our recent period of feature expansion, hopefully this will address some of your concerns.

I'm glad to hear that! I've liked using R2R since I started using it a couple of weeks ago, but I've found it difficult to find what I am looking for in the documentation. I bet your refactoring will help with that!

aphedges commented 1 week ago

To update this issue, the logging documentation is now at https://r2r-docs.sciphi.ai/documentation/deep-dive/main/config#logging and the option is declared at:

https://github.com/SciPhi-AI/R2R/blob/67beded7fa640cbae7d6be21901cd4f8fe1ff088/py/core/base/logging/run_logger.py#L29