Skip to content
This repository has been archived by the owner on Jul 3, 2023. It is now read-only.

Adds more instructions for using and running docker #210

Merged
merged 1 commit into from
Oct 14, 2022

Conversation

skrawcz
Copy link
Collaborator

@skrawcz skrawcz commented Oct 14, 2022

I added a prebuilt image to docker hub and instructions to fetch that.

Otherwise added instructions so that people know how to run the other examples.

Note: we don't auto create environments for all the example because some have other requirements like in the data_quality folders, e.g. requirements-ray.txt which aren't auto generated. So users will have to figure that out themselves.

Changes

  • readme text in examples folder.

Testing

  1. N/A

Notes

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code can be automatically merged (no conflicts)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Passes all existing automated tests
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.
  • Reviewers requested with the Reviewers tool ➡️

Testing checklist

Python - local testing

  • python 3.6
  • python 3.7

I added a prebuilt image to docker hub and instructions to fetch that.

Otherwise added instructions so that people know how to run the
other examples.

Note: we don't auto create environments for all the example because
some have other requirements like in the data_quality folders, e.g.
`requirements-ray.txt` which aren't auto generated. So users will have
to figure that out themselves.
Copy link
Collaborator

@elijahbenizzy elijahbenizzy left a comment

Choose a reason for hiding this comment

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

LGTM

@skrawcz skrawcz merged commit ee6a701 into main Oct 14, 2022
@skrawcz skrawcz deleted the adjust_docker_example_doc branch October 14, 2022 18:22
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants