osanseviero HF staff commited on
Commit
ec619b3
1 Parent(s): da3a594

Create README.md

Browse files
Files changed (1) hide show
  1. README.md +22 -0
README.md ADDED
@@ -0,0 +1,22 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ tags:
3
+ - text-classification
4
+ library_name: generic
5
+ ---
6
+
7
+ # Text Classification repository template
8
+
9
+ This is a template repository for Text Classification to support generic inference with Hugging Face Hub generic Inference API. There are two required steps:
10
+
11
+ 1. Specify the requirements by defining a `requirements.txt` file.
12
+ 2. Implement the `pipeline.py` `__init__` and `__call__` methods. These methods are called by the Inference API. The `__init__` method should load the model and preload all the elements needed for inference (model, processors, tokenizers, etc.). This is only called once. The `__call__` method performs the actual inference. Make sure to follow the same input/output specifications defined in the template for the pipeline to work.
13
+
14
+ ## How to start
15
+ First create a repo in https://hf.co/new.
16
+ Then clone this template and push it to your repo.
17
+ ```
18
+ git clone https://huggingface.co/templates/text-classification
19
+ cd text-classification
20
+ git remote set-url origin https://huggingface.co/$YOUR_USER/$YOUR_REPO_NAME
21
+ git push --force
22
+ ```