mercari/ml-system-design-pattern

System design patterns for machine learning

ml-system-design-pattern's Issues

Example deployment of the patterns in GCP

What is your issue?

Why is it issue?

How do you expect to be?

A indentation error on "Microservice vertical pattern" page

What is your issue?

Hello there, I found an indentation error on this page, located in the [Needs consideration] section.

Although there is no error in the Markdown file of this repo.

Why is it issue?

Maybe just a mistake

How do you expect to be?

Great design pattern summary anyway! 😄

Example deployment of the patterns in AWS

What is your issue?

Why is it issue?

How do you expect to be?

Example deployment of the patterns in kubeflow

What is your issue?

Why is it issue?

How do you expect to be?

Example deployment of the patterns in Azure

What is your issue?

Why is it issue?

How do you expect to be?

Typo: date <> data

What is your issue?

A few typos are present where data is written as date.

Why is it issue?

Because date and data have different meaning.

How do you expect to be?

Where are the issues?

I ran grep -rnw . -e '[D|d]ate' and from what I can see, the typos are there.

./README_ja.md:106:- Date model versioning pattern
./README.md:103:- Date model versioning pattern
./Lifecycle-patterns/Train-then-serve-pattern/Operation-patterns/Data-model-versioning-pattern/design_en.md:36:- Date retrieval (model-name x.y.z-DATA.split)
./Lifecycle-patterns/Train-then-serve-pattern/Operation-patterns/Data-model-versioning-pattern/design_en.md:53:#### Date retrieval (model-name x.y.z-DATA.split) and Release version (model-name X.y.z-data.split)
./Operation-patterns/Data-model-versioning-pattern/design_en.md:36:- Date retrieval (model-name x.y.z-DATA.split)
./Operation-patterns/Data-model-versioning-pattern/design_en.md:53:#### Date retrieval (model-name x.y.z-DATA.split) and Release version (model-name X.y.z-data.split)

English grammer check

What is your issue?

I need somebody to do English grammatical check and fix them.

Why is it issue?

I am not good English writer.

How do you expect to be?

Need English professional to give PR on grammatical fixes.

Translate into Korean

What is your issue?

Thank you for this amazing job. I'm an engineer from Korea and working as a software engineer to create real world services using ML.
I'd like to translate this into Korean for sharing this awesome works to more engineers 🤓

Why is it issue?

How do you expect to be?

Make some edge AI patterns if possible.

What is your issue?

needs patterns for Edge AI: running machine learning on device

Why is it issue?

expected to have more usecases for Edge AI

How do you expect to be?

• patterns for running machine learning inference in smartphone and device
• patterns for training in smartphone and device
• patterns for edge model management, distribution and versioning
• patterns for performance tuning

English-Language Contributor?

What is your issue?

The collection of ML system design information in this repository is fantastic. It has a very intuitive structure and strikes the perfect balance between brevity and depth.

While the English language version, in particular, was well done, there are also some areas in which clarity could potentially be improved; as a native English speaker, the ideas being communicated were often not immediately obvious and often took a few rereads to identify and understand.

Why is it issue?

The information is extremely valuable and improved English phrasing may expand the reach and impact of your work. While high-quality MLOps resources have recently become more readily available, none that I've seen are as approachable and comprehensive as what is contained in this repository.

How do you expect to be?

If an English-language editor and proofreader would be useful to the project, I'd be more than happy to contribute in that capacity. In case it is helpful, I can read/speak a little Japanese;でも、少しだけ😅

---

P.S. Congratulations on the release of your new book!

make diagram edittable

What is your issue?

The diagrams are made in my private files that is difficult to share others for editting.

Why is it issue?

No other contributor cannot remake diagrams based on mine.

How do you expect to be?

Other contributor can fix diagrams, or make a space to create new diagrams.

Example deployment of the patterns in k8s

What is your issue?

Why is it issue?

How do you expect to be?

antipatterns

What is your issue?

add antipatterns

Why is it issue?

better to have don'ts to avoid making mistakes

How do you expect to be?

add antipatterns under each directory

patterns of annotation

What is your issue?

annotating dataset is an important task in ML workflow.
adding annotation in lifecycle patterns or training patterns will make the repo more productive.

Why is it issue?

annotation is difficult and time consuming task. including annotation task in a workflow in an optimized manner should be considered.

How do you expect to be?

include annotation task in lifecycle patterns or training patterns.