-
Notifications
You must be signed in to change notification settings - Fork 6
Cleanup documentation & datascience image #46
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
Merged
chudyandrej
merged 6 commits into
main
from
andrej/pla-3234-cleanup-data-science-image-use-constraintstxt-from-latest
Nov 28, 2024
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
7954ecb
Cleanup constraint.txt file from datascience image and use index instead
chudyandrej c19936c
Clenup documentaion files
chudyandrej 94a5460
Do not creating venv in dockderfile
chudyandrej acee11a
Create venv on the end datascience image
chudyandrej 0af4ece
Remove venv from datascience image
chudyandrej cf8204b
Datascience image install libraires to venv
chudyandrej File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| # Quick Reference | ||
| - **Maintained by**: [Deepnote](https://deepnote.com/) | ||
|
|
||
| ## IR Tags | ||
| - [`4.0.3`, `4.2.0`] | ||
|
|
||
| ## What is Deepnote IR? | ||
| Deepnote IR provides official Docker images that are pre-configured for use on [Deepnote](https://deepnote.com). These images include the R programming language installed in specific versions, along with the [IRkernel](https://github.com/IRkernel/IRkernel), which is an R kernel for Jupyter. | ||
|
|
||
| These images are designed to facilitate seamless integration with Deepnote's platform, allowing users to leverage R for data analysis and visualization within Jupyter notebooks. If you find that the provided images do not meet all your requirements, you are encouraged to extend them by building your own custom images on top of these bases. | ||
|
|
||
| ## How to Customize Your Image | ||
| To create a custom Docker image based on Deepnote's IR images, you can use the following example Dockerfile: | ||
|
|
||
| ```dockerfile | ||
| FROM deepnote/ir:4.2.0 | ||
|
|
||
| RUN R -e "install.packages('tidyverse', repos='https://cloud.r-project.org', dependencies=TRUE)" | ||
| ``` | ||
|
|
||
| This example demonstrates how to build upon the `deepnote/ir:4.2.0` image by installing the tidyverse package, a collection of R packages designed for data science. You can modify this Dockerfile to include other R packages or configurations as needed. | ||
|
|
||
| # Additional Information | ||
| These images serve as a robust foundation for R-based data science projects within Deepnote, providing the necessary tools and libraries to get started quickly. For more detailed information about Deepnote and how these images can enhance your data science workflows, please visit Deepnote's website. | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| # Quick Reference | ||
| - **Maintained by**: [Deepnote](https://deepnote.com/) | ||
|
|
||
| # Supported Tags and Respective Dockerfile Links | ||
| - [`3.8`, `3.9`, `3.10`, `3.11`](https://github.com/deepnote/environments/tree/main/python/python) | ||
| - [`3.8-datascience`, `3.9-datascience`, `3.10-datascience`, `3.11-datascience`](https://github.com/deepnote/environments/blob/main/python/datascience/Dockerfile.datascience) | ||
|
|
||
| # What is Deepnote Python? | ||
| Deepnote Python is a set of Docker images tailored for use in the Deepnote platform. These images are based on the official [Python Docker images](https://hub.docker.com/_/python) and include additional binaries and configurations to enhance the user experience within Deepnote. They are designed to simplify development workflows, especially for data science projects, by providing pre-configured environments that are ready to use. | ||
|
|
||
| # How to Use This Image | ||
|
|
||
| ## Create Custom Dockerfile for Deepnote Use | ||
| To create a custom Dockerfile using Deepnote's Python image, you can start with the following template: | ||
|
|
||
| ```dockerfile | ||
| ARG PYTHON_VERSION=3.9 | ||
| FROM deepnote/python:$PYTHON_VERSION | ||
|
|
||
| #Determine the Python version and set the version-specifications file | ||
| ARG PYTHON_VERSION | ||
|
|
||
| COPY requirements.txt ./ | ||
| RUN pip install --no-cache-dir -r requirements.txt -c https://tk.deepnote.com/constraints${PYTHON_VERSION}.txt | ||
| ``` | ||
|
|
||
| This Dockerfile uses the `deepnote/python:3.9` image as a base and installs Python packages specified in requirements.txt. The use of constraints from `https://tk.deepnote.com/constraints<python_version>.txt` ensures compatibility and stability of package installations. | ||
|
|
||
| # Additional Information | ||
| These images are intended to serve as a starting point for creating reproducible and scalable data science environments in Deepnote. They include various utilities and binaries that streamline workflows, such as Jupyter support, data visualization tools, and more. | ||
| For more information about Deepnote and how these images can be used to enhance your data science projects, visit Deepnote's website. |
This file was deleted.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@chudyandrej what would happen in the datascience images, if we keep it here as well?