lightly-ai / lightly-ai/lightly

Integrate Lightly with Hugging Face

Open
#1,672 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
3.8k
Forks
367
Avg merge
3d 22h
Merged PRs (30d)
5

Description

Hi,

Niels here from the community science team at Hugging Face 🤗 . I noticed your work as it was trending on paperswithcode, and saw you currently host all checkpoints on your own servers, e.g. https://lightly-ssl-checkpoints.s3.amazonaws.com/imagenet_resnet50_barlowtwins_2023-08-18_00-11-03/pretrain/version_0/checkpoints/epoch%3D99-step%3D500400.ckpt.

Did you know that hosting on HF is free, and would allow for better discoverability of your work?

If you're interested, leaving a guide here on how Lightly could be integrated with the hub: https://huggingface.co/docs/hub/en/models-adding-libraries. Basically, it comes down to automated tagging of models which get pushed to the hub (if a user uses lightly for training, we could integrate a `push_to_hub` method which then automatically tags the corresponding model in the model card with `library_name: lightly`).

We've done a similar thing in the past with libraries like Sentence Transformers, Timm, OpenCLIP, Spacy, and so on.

Let us know if you're interested, we're happy to assist the HF integration.

Kind regards,

Niels

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Hugging Face model-library integration guide linked in the issue, then inspect how Lightly currently hosts checkpoints. Clarify the integration scope with maintainers; done should include an agreed way to push Lightly-trained models to the Hub and apply the `library_name: lightly` model-card tag.

Written by the indexing model from the issue text.

Assessment

Tech stack
huggingface, python
Domain
machine-learning
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.