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

Standardize name for LLM comps #1162

Merged
merged 1 commit into from
Jan 16, 2025
Merged

Standardize name for LLM comps #1162

merged 1 commit into from
Jan 16, 2025

Conversation

XinyaoWa
Copy link
Collaborator

@XinyaoWa XinyaoWa commented Jan 16, 2025

Description

Update all the names for classes and files in llm comps to follow the standard format

Issues

#998

Type of change

List the type of change like below. Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds new functionality)
  • Breaking change (fix or feature that would break existing design and interface)
  • Others (enhancement, documentation, validation, etc.)

Dependencies

no

Tests

tests/llm/*.sh

Update all the names for classes and files in llm comps to follow the standard format

Related to issue #998

Signed-off-by: Xinyao Wang <[email protected]>
XinyaoWa added a commit to opea-project/GenAIExamples that referenced this pull request Jan 16, 2025
Update all the names for classes and files in llm comps to follow the standard format, related GenAIComps PR opea-project/GenAIComps#1162

Signed-off-by: Xinyao Wang <[email protected]>
XinyaoWa added a commit to opea-project/GenAIExamples that referenced this pull request Jan 16, 2025
Update all the names for classes and files in llm comps to follow the standard format, related GenAIComps PR opea-project/GenAIComps#1162

Signed-off-by: Xinyao Wang <[email protected]>
@chensuyue chensuyue merged commit a65e559 into main Jan 16, 2025
24 checks passed
@chensuyue chensuyue deleted the llm_fix_name branch January 16, 2025 15:06
XinyaoWa added a commit to opea-project/GenAIExamples that referenced this pull request Jan 16, 2025
Update all the names for classes and files in llm comps to follow the standard format, related GenAIComps PR opea-project/GenAIComps#1162

Signed-off-by: Xinyao Wang <[email protected]>
chensuyue pushed a commit to opea-project/GenAIExamples that referenced this pull request Jan 16, 2025
Update all the names for classes and files in llm comps to follow the standard format, related GenAIComps PR opea-project/GenAIComps#1162

Signed-off-by: Xinyao Wang <[email protected]>
@eero-t
Copy link
Contributor

eero-t commented Jan 17, 2025

Update all the names for classes and files in llm comps to follow the standard format

@XinyaoWa Which standard format that is?

Neither this PR description, nor files it changes, contains a link to any specific standard, or rules being followed in naming.

The result seems rather inconsistent:

GenAIComps$ git grep -h OpeaComponentRegistry.register | grep -e DocSum -e TextGen -e DATA
@OpeaComponentRegistry.register("OPEA_DATAPREP_MILVUS")
@OpeaComponentRegistry.register("OPEA_DATAPREP_REDIS")
@OpeaComponentRegistry.register("OpeaDocSumTgi")
@OpeaComponentRegistry.register("OpeaDocSumvLLM")
@OpeaComponentRegistry.register("OpeaTextGenNative")
@OpeaComponentRegistry.register("OpeaTextGenPredictionguard")
@OpeaComponentRegistry.register("OpeaTextGenService")
  • some names are all caps with underlines, some use CamelCase without any underlines
  • Some items are capitalized (."..Tgi"), some are the opposite of it ("...vLLM"), even in same component (DocSum)
  • Some items have backend name as suffix (DataPrep & DocSum), others something else ("OpeaTextGenService")

PS. IMHO "OpeaDocSum_TGI" / "OpeaDocSum_vLLM" were more reasonable and readable names than the new ones. Earlier suffix matched backend's official name, and was clearly separated from application / use-case prefix.

smguggen pushed a commit to opea-aws-proserve/GenAIComps that referenced this pull request Jan 23, 2025
Update all the names for classes and files in llm comps to follow the standard format

Related to issue opea-project#998

Signed-off-by: Xinyao Wang <[email protected]>

Convert Bedrock microservice to follow text-gen structure

Signed-off-by: Jonathan Minkin <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants