-
Notifications
You must be signed in to change notification settings - Fork 2.6k
Addon params #1514
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Addon params #1514
Conversation
Could you please provide an overview of the rationale behind implementing the --addon_params transmission? Specifically, what challenges or issues does this feature aim to address? |
Again my apologies for the linting issues. |
Thank you for your contribution to the community. While the proposal to enhance Instead, we recommend configuring Additionally, we’ve observed that the current PR disrupts the existing SUMMARY_LANGUAGE environment variable functionality, preventing dependent workflows from operating as intended in the updated version. We kindly request addressing this regression to maintain a seamless user experience. Please let us know if you have any questions or need further clarification. We appreciate your efforts and look forward to collaborating on this improvement. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should adhere to the principle that all configurations can be managed through the .env file, eliminating the need to rely on command-line parameters.
Finally, is there a way to configure a |
Description
[Briefly describe the changes made in this pull request.]
This PR introduces the addon_params feature, allowing users to pass additional configuration parameters via the --addon_params argument or the ADDON_PARAMS field in the .env file. These parameters are parsed as a JSON string and integrated into the existing configuration system (config.py/parse_args). The default value for addon_params is set to { "language": "English" }, ensuring no disruption to existing workflows.(my apologies for the linter issues).
Rationale
The addon_params feature addresses the need for greater flexibility and customization in LightRAG's workflows. It allows users to dynamically inject additional parameters, such as language preferences, entity types, or other custom settings, without modifying the core codebase. This is particularly useful for:
Custom Workflows: Tailoring the system's behavior for domain-specific tasks or research experiments.
Dynamic Configuration: Enabling runtime adjustments to configurations without requiring code changes or redeployment.
Limitation
While addon_params is fully supported in LightRAG's core functionality, its usage is limited when using the prepackaged lightrag_server to the default values. I understand that advanced users are encouraged to use the API rather than the prepackaged LightRAG_server, yet I also would like to highlight that it is very user friendly for new users.
By retaining a default value of { "language": "English" }, this feature ensures backward compatibility and does not interfere with existing workflows, making it a seamless enhancement for both new and existing users.
Related Issues
#1239
[Reference any related issues or tasks addressed by this pull request.]
Changes Made
[List the specific changes made in this pull request.]
Checklist
Additional Notes
[Add any additional notes or context for the reviewer(s).]