Flipping logic for lfs install, README edits - #3
Merged
Merged
Conversation
First-round edits to README, prior to attempting installation
…r for larger birefnet weights
Initial README edits, edited to resolve conflicts with dev branch
Ported from main (fbb3c09) onto dev at e7904eb. Agent instructions and docs - AGENTS.md: public agent guide, the single source of truth; CLAUDE.md imports it. docs/faq.md: human FAQ, linked from the README. - .gitignore: commit CLAUDE.md and AGENTS.md; ignore *.local.md. - README, FAQ, AGENTS: Git LFS is an install prerequisite (a clone made without it yields a 134-byte pointer stub, not the model), RF-DETR arrives with the clone, and `mats fetch-weights` is the repair path. Repair uses `git lfs pull --exclude=weights/birefnet_leaf.pth`, which stays RF-DETR-only whether or not .lfsconfig's fetchexclude is active. - README: reconciled with the restructure from PR #2; its headings and TOC are kept, and the hand-edited doctor/fetch paragraph is preserved verbatim. Also carried over from fbb3c09 (app work, unrelated to the docs) - src/mats/app/Home.py, branding.py, src/mats/core.py, pyproject.toml, tests/test_home_app.py Known and not addressed here - .lfsconfig has fetchexclude commented out on dev, so a clone now fetches BiRefNet (2.65 GB) as well as RF-DETR. - tests/test_weights.py::test_status_missing_for_excluded_checkout_pointer already fails on dev before this commit (message reworded in PR #2). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
ackermanar
approved these changes
Sep 21, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
General first-pass edits across the README
Existing logic for LFS file install was to exclude the large BiRefNet weights in the
.lfsconfigand override that exclusion withgit lfs pull --include [weights.pth]when the user requests it.I could not get that override to work correctly, either on my Macbook or on an Ubuntu docker image. The man pages for
git lfssuggest that it should work, not sure what the problem is.Instead, I flipped the logic around in
weights.pyand in the.lfsconfig. Instead of the lfsconfig excluding the file and the commands including it, the two relevant lines in the lfsconfig are commented out and the weights fetching tools will always rungit lfs pull --exclude [weights.pth]by default, unless the user specifies that they want to retrieve the BiRefNet weights