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

update docs to remove cookiecutter and add asset bundle templates #98

Merged

Conversation

mingyu89
Copy link
Contributor

@mingyu89 mingyu89 commented Aug 24, 2023

Signed-off-by: Mingyu Li <[email protected]>
Copy link
Collaborator

@arpitjasa-db arpitjasa-db left a comment

Choose a reason for hiding this comment

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

Looks great! Minor comments. Can we confirm there are no other instances of cookiecutter or its syntax in the docs?

README.md Outdated
Comment on lines 51 to 52
* ``input_root_dir``: name of the root directory. The root directory name should be specified if monorepo will be used for the project.
Otherwise, user can use the name of the current project as root directory name.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Leaving it blank is no longer an option? We should make it clearer:

Suggested change
* ``input_root_dir``: name of the root directory. The root directory name should be specified if monorepo will be used for the project.
Otherwise, user can use the name of the current project as root directory name.
* ``input_root_dir``: name of the root directory. It is recommended to use the name of the current project as the root directory name, except in the case of a monorepo with other projects where the name of the monorepo should be used instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes. Leave it black will use the default value my-mlops-project. Good suggestion.

README.md Outdated
@@ -174,12 +173,12 @@ of the example project:
```
# Note: update MLOPS_STACK_PATH to the path to your local checkout of the stack
MLOPS_STACK_PATH=~/mlops-stack
cookiecutter "$MLOPS_STACK_PATH" --config-file "$MLOPS_STACK_PATH/tests/example-project-configs/azure/azure-devops.yaml" --no-input --overwrite-if-exists
databricks "$MLOPS_STACK_PATH" --config-file "$MLOPS_STACK_PATH/tests/example-project-configs/azure/azure-devops.json"
Copy link
Collaborator

Choose a reason for hiding this comment

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

just databricks? not databricks bundle?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. Should be databricks bundle init

Signed-off-by: Mingyu Li <[email protected]>
@mingyu89 mingyu89 merged commit 3cee60b into use-asset-templates-fix-tests Aug 26, 2023
1 check passed
mingyu89 added a commit that referenced this pull request Aug 26, 2023
* Fix all mlops stacks tests

Signed-off-by: Mingyu Li <[email protected]>

* Remove all cookiecutter references from tests

Signed-off-by: Mingyu Li <[email protected]>

* black .

Signed-off-by: Mingyu Li <[email protected]>

* Remove cookiecutter parameter file

Signed-off-by: Mingyu Li <[email protected]>

* Rename more azure_devlops

Signed-off-by: Mingyu Li <[email protected]>

* Bump version of databricks cli

Signed-off-by: Mingyu Li <[email protected]>

* update docs to remove cookiecutter and add asset bundle templates (#98)

* Update docs

Signed-off-by: Mingyu Li <[email protected]>

* Add more information about asset templats and link about databricks cli

Signed-off-by: Mingyu Li <[email protected]>

* Fix doc issues

Signed-off-by: Mingyu Li <[email protected]>

---------

Signed-off-by: Mingyu Li <[email protected]>

---------

Signed-off-by: Mingyu Li <[email protected]>
@mingyu89 mingyu89 deleted the use-asset-templates-update-docs branch August 26, 2023 01:14
mingyu89 added a commit that referenced this pull request Sep 7, 2023
…eation (#96)

* WIP

Signed-off-by: Mingyu Li <[email protected]>

* Complete the implementation and fix all issues

Signed-off-by: Mingyu Li <[email protected]>

* Skip the test data file when recipe is not used

Signed-off-by: Mingyu Li <[email protected]>

* Add back support for root dir

Signed-off-by: Mingyu Li <[email protected]>

* Fix all inconsistency issues based on validation

Signed-off-by: Mingyu Li <[email protected]>

* Revert changes to stacks docs

Signed-off-by: Mingyu Li <[email protected]>

* Replace azure_devlops with azure_devops

Signed-off-by: Mingyu Li <[email protected]>

* Fix all mlops stacks tests (#97)

* Fix all mlops stacks tests

Signed-off-by: Mingyu Li <[email protected]>

* Remove all cookiecutter references from tests

Signed-off-by: Mingyu Li <[email protected]>

* black .

Signed-off-by: Mingyu Li <[email protected]>

* Remove cookiecutter parameter file

Signed-off-by: Mingyu Li <[email protected]>

* Rename more azure_devlops

Signed-off-by: Mingyu Li <[email protected]>

* Bump version of databricks cli

Signed-off-by: Mingyu Li <[email protected]>

* update docs to remove cookiecutter and add asset bundle templates (#98)

* Update docs

Signed-off-by: Mingyu Li <[email protected]>

* Add more information about asset templats and link about databricks cli

Signed-off-by: Mingyu Li <[email protected]>

* Fix doc issues

Signed-off-by: Mingyu Li <[email protected]>

---------

Signed-off-by: Mingyu Li <[email protected]>

---------

Signed-off-by: Mingyu Li <[email protected]>

* Add order to the stacks template schema

Signed-off-by: Mingyu Li <[email protected]>

* Update cli version to v0.204.0. Throw exception when users try to create project using cookiecutter

Signed-off-by: Mingyu Li <[email protected]>

* Fix version used by test

Signed-off-by: Mingyu Li <[email protected]>

* Fix tests by adding a dummy default profile to databricks CLI before generating project

Signed-off-by: Mingyu Li <[email protected]>

---------

Signed-off-by: Mingyu Li <[email protected]>
@mabreuortega
Copy link

Having issues installing using the new databricks bundle init

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