Skip to content

Update Dockerfile and docs - #261

Merged
maryapp merged 5 commits into
mainfrom
update_dj_pipeline
Feb 6, 2026
Merged

Update Dockerfile and docs#261
maryapp merged 5 commits into
mainfrom
update_dj_pipeline

Conversation

@lecriste

Copy link
Copy Markdown
Collaborator

This PR updates an obsolete package in dj_pipeline/Dockerfile that was causing the build to fail, and expands the docs with the exact copy-and-paste commands needed.

It only affects the sections I’ve finished testing; additional updates (e.g. in the Makefile) will follow in a separate PR.

A few wording tweaks in the docs came from a ChatGPT review, I wouldn’t have been so picky myself :)

@lecriste lecriste self-assigned this Jan 30, 2026
@lecriste lecriste added bug Something isn't working documentation Improvements or additions to documentation labels Jan 30, 2026
@lecriste
lecriste requested a review from maryapp January 30, 2026 16:52
@lecriste

Copy link
Copy Markdown
Collaborator Author

@maryapp, I noticed you just restructured the docs - thank you!

I would still keep the jupyter-notebook sub-section though, I found it useful.
Should I rebase this PR on top of your changes?

@maryapp

maryapp commented Feb 3, 2026

Copy link
Copy Markdown
Collaborator

@lecriste there is a docker notebook sub-section; I guess the goal is to switch to docker, and keep conda optional (very optional). But yes, you are welcomed to add anything you consider useful!!

@lecriste

lecriste commented Feb 5, 2026

Copy link
Copy Markdown
Collaborator Author

@maryapp, I updated this PR by rebasing the docs on your latest version and adding an automatic test workflow for the Dockerfile.
This workflow should run in the DJ migration PR #249.
Can you please review?

@maryapp
maryapp requested a review from Copilot February 6, 2026 12:11

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR resolves a Docker build failure by updating an obsolete package dependency and enhances documentation with explicit setup instructions for remote database access via Jupyter Notebook.

Changes:

  • Fixed package name from umap to umap-learn in Dockerfile dependencies
  • Added default values for Docker build arguments to support CI workflows
  • Created GitHub Actions workflow to validate Docker builds
  • Expanded README with step-by-step Jupyter Notebook setup instructions

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
dj_pipeline/Dockerfile Updated obsolete package name and added default build argument values for CI compatibility
dj_pipeline/README.md Added comprehensive Jupyter Notebook setup guide with exact installation commands
.github/workflows/docker-build.yml New CI workflow to automatically test Docker image builds

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread dj_pipeline/Dockerfile Outdated
Comment thread dj_pipeline/Dockerfile
@@ -1 +1 @@
FROM deeplabcut/deeplabcut:2.3.5-core-cuda11.7.1-cudnn8-runtime-ubuntu20.04-latest

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@lecriste, I'm thinking now... maybe we want dlc 3 for this one (for the newer version)

@lecriste lecriste Feb 6, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@lecriste I would still keep the version (not latest)

@lecriste lecriste Feb 6, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

OK, let's follow up here:
a3e7099#r176590225

@maryapp maryapp changed the title Update dj_pipeline Update Dockerfile and docs Feb 6, 2026
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: mary <43879378+maryapp@users.noreply.github.com>
@maryapp
maryapp merged commit fdb39c7 into main Feb 6, 2026
3 checks passed
@maryapp
maryapp deleted the update_dj_pipeline branch February 6, 2026 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants