Skip to content
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

Model configurability naming changes #129

Open
dlqqq opened this issue Apr 28, 2023 · 0 comments
Open

Model configurability naming changes #129

dlqqq opened this issue Apr 28, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@dlqqq
Copy link
Member

dlqqq commented Apr 28, 2023

  • Standardize terminology for model providers:
    • *LmProvider: language model provider
    • *EmProvider: embedding model provider
  • Rename GlobalConfig to ChatConfig
  • Add a "glossary" section to contributor docs that covers all of the acronyms used throughout the project
  • Add a section to contributor docs regarding terminology preferences:
    • The name of a class, all lowercase, should only refer to an instance of that class. So for example, a variable/attribute named provider should always refer to an instance of *Provider, not the class or a provider ID.
    • Always label IDs by suffixing with _id.
    • Always label classes by suffixing with _class.
@dlqqq dlqqq added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 28, 2023
@JasonWeill JasonWeill added this to the Future milestone Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants