databricks / mlops-stacks

This repo provides a customizable stack for starting new ML projects on Databricks that follow production best-practices out of the box.
https://docs.databricks.com/en/dev-tools/bundles/mlops-stacks.html
Apache License 2.0
429 stars 143 forks source link

Update docs and add doc for seting up monorepo #64

Closed mingyu89 closed 1 year ago

mingyu89 commented 1 year ago

Fix docs after project layout refactoring.

If mono repo is used, current step is to use mlops-stacks to generate another project and copy a bunch of files. It might be better to include a cookiecutter project inside the generated project and directly generated these files.

In current approach, files in .github/workflows/ could have name conflicts. We are asking user to rename files before copying to the mono repo. Another option is to add the project name as prefix to these yaml files.

Anyway, this PR is to fix docs. For mono repo support, we can decide and do more later.

mingyu89 commented 1 year ago

Feel free to comment as much as possible. Generated project https://github.com/mingyu89/test-repo1/tree/update-doc

mingyu89 commented 1 year ago

Ready for an initial review

mingyu89 commented 1 year ago

@vladimirk-db Thank you! I have so many typos!