- 
                Notifications
    You must be signed in to change notification settings 
- Fork 538
PR template when adding a new library #913
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
      
      
    
  
     Merged
                    Changes from all commits
      Commits
    
    
            Show all changes
          
          
            3 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      
    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,34 @@ | ||
| # What does this PR do? | ||
|  | ||
| This PR adds support for the library [TO BE COMPLETED]. | ||
|  | ||
| Link to library repo: [TO BE COMPLETED]. | ||
|  | ||
| Link to models on the Hub: https://huggingface.co/models?other=[to-be-completed]. | ||
|  | ||
| ## Main instructions | ||
|  | ||
| Please check that all prerequisites are met. | ||
|  | ||
| - [ ] A new library has been added to [model-libraries.ts](https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/model-libraries.ts#L60). | ||
| - [ ] The alphabetical order of `MODEL_LIBRARIES_UI_ELEMENTS` has been preserved. | ||
| - [ ] The library id is lowercased and hyphen-separated (example: `"adapter-transformers"`). | ||
| - [ ] At least one model is referenced on https://huggingface.co/models?other=my-library-name. If not, the model card metadata of the relevant models must be updated to add `library_name: my-library-name` (see [example](https://huggingface.co/google/gemma-scope/blob/main/README.md?code=true#L3)). If you are not the owner of the models on the Hub, please open PRs (see [example](https://huggingface.co/MCG-NJU/VFIMamba/discussions/1)). **Note:** if no models are listed, this PR won't be merged. | ||
| - [ ] `repoName` and `prettyLabel` are set with user-friendly casing (example: `DeepForest`). | ||
| - [ ] `repoUrl` is set with a link to the library source code (usually a GitHub repository). | ||
| - [ ] (optional) `docsUrl` is set with a link to the docs of the library. If the documentation is in the GitHub repo referenced above, no need to set it twice. | ||
| - [ ] `filter` is set to `false`. | ||
| - [ ] `countDownload` follows the correct convention and do not duplicate the counting. For instance, if loading a model requires 3 files, the download count rule must count downloads only on 1 of the 3 files. Otherwise, the download count will be overestimated. If the library uses one of the default config files (`config.json`, `config.yaml`, `hyperparams.yaml`, and `meta.yaml`, see [here](https://huggingface.co/docs/hub/models-download-stats#which-are-the-query-files-for-different-libraries)), there is no need to manually define a download count rule. | ||
| - [ ] (optional) `snippets` is correctly defined. See check-list below. | ||
| - [ ] Make sure that the code passes the linter test as well | ||
|  | ||
| ## (optional) Snippets instructions | ||
|  | ||
| Adding a code snippet helps users to start using your library. It is especially useful when the library is tightly integrated with the Hub and typically has a `Model.from_pretrained` helper method. Check out [this guide](https://huggingface.co/docs/huggingface_hub/guides/download) to learn how to download files in Python and [this guide](https://huggingface.co/docs/huggingface_hub/guides/integrations) for a broader explanation on how to integrate a library with the Hub. Note that adding a code snippet is optional. | ||
| For code snippets specifically, please refer to this checklist: | ||
|  | ||
| - [ ] Code snippet has been defined in [model-libraries-snippets.ts](https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/model-libraries-snippets.ts) and added to [model-libraries.ts](https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/src/model-libraries.ts#L60). | ||
| - [ ] Code snippet does not contain installation instruction. | ||
| - [ ] Code snippet is minimal (only loading / calling the model with simple config). | ||
| - [ ] (recommended) Code snippet is generated from `ModelData`, typically to get the correct command to load a specific model. | ||
| - [ ] (optional) It's possible to define multiple code snippets (by returning a list) to showcase different usage. | ||
      
      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.
  
    
  
    
Uh oh!
There was an error while loading. Please reload this page.