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

Add boston housing example #27

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

davidjurado
Copy link
Contributor

@davidjurado davidjurado commented Jul 9, 2021

This example is a tutorial on how to pack an existing project into MLCube using config 2.0

Please refer to the README.

@github-actions
Copy link

github-actions bot commented Jul 9, 2021

MLCommons CLA bot All contributors have signed the MLCommons CLA ✍️ ✅

bitfort
bitfort previously approved these changes Jul 19, 2021
@@ -0,0 +1,29 @@
name: MLCommons Boston Housing
Copy link

Choose a reason for hiding this comment

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

I don't follow why this is called ".mlcube.yaml"; whats the motivation for prefixed "."?

Copy link
Contributor Author

@davidjurado davidjurado Jul 19, 2021

Choose a reason for hiding this comment

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

The ".mlcube.yaml" file corresponds to the packed version for the MLCube definition, this file contains the needed information to unpack the full MLCube original structure for folders and files using the command: mlcube describe. This will also generate a file called "mlcube.yaml" (without the initial dot) that is the original MLCube structure definition file.

I'm currently working on the implementation of config 2.0 for this tutorial, when this is done we won't need to extract the MLCube original folder structure, and instead, there will be only a single file called: "mlcube.yaml" with all the needed information.

@@ -0,0 +1,216 @@
# Packing an existing project into MLCUbe
Copy link

Choose a reason for hiding this comment

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

Great job going through explaining things in detail!

@@ -0,0 +1,34 @@
"""Download the raw Boston Housing Dataset"""
Copy link

Choose a reason for hiding this comment

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

Love the simple straight forward files you built here!

@@ -0,0 +1,73 @@
"""MLCube handler file"""
Copy link

Choose a reason for hiding this comment

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

This is a great main file - and I'm thinking about how we can further simplify this in the spec; nothing need to change here, but long term we should think about how to make this file simple for people to create :)

@davidjurado davidjurado force-pushed the feature/boston_housing branch from 83f6785 to cecbc54 Compare September 7, 2021 21:38
sergey-serebryakov and others added 3 commits September 30, 2021 13:12
…ime. (mlcommons#35)

The greeting message printed by this MLCube can differ if it runs for 1st time or not. It identifies this by checking if a chat file exists. The MLCube was implemented so that it was checking for file existence after opening this file, so the function that checks if file exists or not was always returning true.
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