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

General housekeeping #54

Merged
merged 8 commits into from
Jan 16, 2024
Merged

General housekeeping #54

merged 8 commits into from
Jan 16, 2024

Conversation

nstogner
Copy link
Contributor

@nstogner nstogner commented Jan 11, 2024

  • Update readme
  • Change test names / directories
  • Update development.md guide

NOTE: No actual changes to testing code were made. Changes to workflow files are mostly for readability of files and also of the checks as displayed on PRs.

@nstogner nstogner force-pushed the housekeeping branch 2 times, most recently from 4e78b44 to 315e8cd Compare January 13, 2024 16:11
@nstogner nstogner changed the title WIP: General housekeeping General housekeeping Jan 13, 2024
@@ -1,4 +1,4 @@
name: Create and publish a Docker image
name: Build and Push
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Build and Push Container Image?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Screenshot 2024-01-15 at 8 31 22 PM

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am fine reverting, but the reason I made these changes: "Build and Push" as the title of the workflow and "container" as what is being built and pushed. I think it displays nicely on the output.

README.md Outdated
@@ -1,36 +1,41 @@
# Lingo - K8s LLM Proxy + Scaler
# Lingo - The lightweight model proxy
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do think we should add K8s in the title so it's clear that this only works on K8s and is very focused towards K8s.

What about one of these options?

  • The lightweight ML Model proxy and autoscaler for K8s
  • Lightweight K8s ML Proxy and Autoscaler
  • K8s ML Proxy and Autoscaler

Copy link
Contributor Author

@nstogner nstogner Jan 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about leaving the title block just the name (# Lingo) and keeping the description in the description section of the repo? I feel like these are too long for an H1.

Copy link
Contributor

@samos123 samos123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly some opinions around naming.

Copy link
Contributor

@alpe alpe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good work

.github/workflows/tests.yml Show resolved Hide resolved
Makefile Show resolved Hide resolved
Copy link
Contributor

@samos123 samos123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Names look good based on screenshot

@nstogner nstogner merged commit d4896cf into main Jan 16, 2024
3 checks passed
@nstogner nstogner deleted the housekeeping branch January 16, 2024 02:37
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.

3 participants