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

Improve and expand the tutorials #3

Merged
merged 8 commits into from
Nov 10, 2023
Merged

Conversation

RobbeSneyders
Copy link
Member

I made some further improvements to both the notebook and the README. I would like us to update all examples to match this.

Some changes:

  • Make sure we link back to fondant and include a smaller version from the logo
  • Remove unused art
  • Have a main README which points to both a README and notebook tutorial
  • Add automated prerequisite checks
  • Expand the tutorial to include some customization of the pipeline

"try:\n",
" import fondant\n",
"except ImportError:\n",
" logging.warning(\"Please install Fondant from the `requirements.txt` at the root of this repository\")"
Copy link
Contributor

Choose a reason for hiding this comment

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

I would add a cell to install the requirements.txt from the notebook. To make it really bulletproofed.

Copy link
Collaborator

@PhilippeMoussalli PhilippeMoussalli left a comment

Choose a reason for hiding this comment

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

Nice improvements! Left a few suggestions

src/README.md Outdated Show resolved Hide resolved
src/README.md Outdated Show resolved Hide resolved
src/pipeline.py Show resolved Hide resolved
src/pipeline.py Outdated Show resolved Hide resolved
src/pipeline.py Show resolved Hide resolved
Co-authored-by: Philippe Moussalli <[email protected]>
Copy link
Collaborator

@PhilippeMoussalli PhilippeMoussalli left a comment

Choose a reason for hiding this comment

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

Thanks Robbe! I will update the datacomp repo based on this

Copy link
Contributor

@mrchtr mrchtr left a comment

Choose a reason for hiding this comment

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

Thanks @RobbeSneyders. Last small nitpick for M1 users.

"\n",
"from pathlib import Path\n",
"\n",
"DockerCompiler().compile(pipeline=pipeline, output_path=\"docker-compose.yml\")\n",
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we still add this to make it work on a M1 machine:

Suggested change
"DockerCompiler().compile(pipeline=pipeline, output_path=\"docker-compose.yml\")\n",
"import os\n",
"os.environ["DOCKER_DEFAULT_PLATFORM"]="linux/amd64"\n",
"DockerCompiler().compile(pipeline=pipeline, output_path=\"docker-compose.yml\")\n",

@RobbeSneyders RobbeSneyders merged commit 09dae57 into main Nov 10, 2023
1 check passed
@RobbeSneyders RobbeSneyders deleted the feature/improve-tutorial branch November 10, 2023 13:45
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