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

Update README.md #21

Closed
wants to merge 1 commit into from
Closed

Update README.md #21

wants to merge 1 commit into from

Conversation

adarshxs
Copy link
Collaborator

@adarshxs adarshxs commented Aug 19, 2023

To clearly mention how to download the models from git lfs.

probably fixes #19

Following the previous instructions never downloaded models. It was just downloading pointers to the large files stored on git lfs. Hope this fixes it.

@adarshxs
Copy link
Collaborator Author

Edit: yes fixes #19 @JoshuaElsdon

@JoshuaElsdon
Copy link
Contributor

Hey thanks for the contribution! I agree we could be clearer about the git-lfs requirement. It was only called out explicitly in the demo readme file. (example.md).

I think for completeness it would be better to link to https://git-lfs.com/ rather than provide line by line examples that are specific to linux, this way we can cover the installation for all OSes without making the readme difficult to parse.

The pull on git-lfs submodules should not be needed. Init followed by update should get all the files. I will modify your contribution and test it on a clean machine.

@adarshxs
Copy link
Collaborator Author

I'll be closing this pr. Thanks!

@adarshxs adarshxs closed this Aug 22, 2023
@JoshuaElsdon
Copy link
Contributor

An equivalent change has been merged into main now. Thanks for the report!

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.

failed:Protobuf parsing failed
2 participants