formatting

Author: pr-Mais

extensions/firestore-huggingface-inference-api/POSTINSTALL.md

@@ -5,6 +5,7 @@ You can test out this extension right away!
 Depending on the task you want to run, add a new Firestore document to `${param:collectionPath}`.
 
 For example, if you want to run a text classification task using the model [`distilbert-base-uncased-finetuned-sst-2-english`](https://huggingface.co/distilbert-base-uncased-finetuned-sst-2-english), add a new document to `${param:collectionPath}` with the following fields:
+
 ```
 {
   "inputs": "You're amazing!"

extensions/firestore-huggingface-inference-api/README.md

@@ -1,10 +1,8 @@
 # Trigger Hugging Face inference API from Firestore
 
-**Author**: undefined 
-
-**Description**: This extension triggers the Hugging Face inference API when  a new document is created in a Firestore collection.
-
+**Author**: undefined
 
+**Description**: This extension triggers the Hugging Face inference API when a new document is created in a Firestore collection.
 
 **Details**: Use this extension to run inferences in a Firestore collection using the [Hugging Face inference API](https://huggingface.co/docs/api-inference).
 
@@ -25,39 +23,30 @@ This extension uses other Firebase or Google Cloud Platform services which may h
 
 When you use Firebase Extensions, you're only charged for the underlying resources that you use. A paid-tier billing plan is only required if the extension uses a service that requires a paid-tier plan, for example calling to a Google Cloud Platform API or making outbound network requests to non-Google services. All Firebase services offer a free tier of usage. [Learn more about Firebase billing.](https://firebase.google.com/pricing)
 
-
-
-
 **Configuration Parameters:**
 
-* Hugging Face Access Token: You can find your API token on your [Hugging Face account page](https://huggingface.co/settings/token).
-From Hugging Face docs:
-You should see a token hf_xxxxx (old tokens are api_XXXXXXXX or api_org_XXXXXXX).
-If you do not submit your API token when sending requests to the API, you will not be able to run inference on your private models.
-
-* Model ID: The Model ID from [Hugging Face Model Hub](https://huggingface.co/models).
-Check the [recommended models for each ML task available](https://api-inference.huggingface.co/docs/python/html/detailed_parameters.html#detailed-parameters),  or the [Tasks](https://huggingface.co/tasks) overview.
+- Hugging Face Access Token: You can find your API token on your [Hugging Face account page](https://huggingface.co/settings/token).
+  From Hugging Face docs:
+  You should see a token hf_xxxxx (old tokens are api_XXXXXXXX or api_org_XXXXXXX).
+  If you do not submit your API token when sending requests to the API, you will not be able to run inference on your private models.
 
-* Inference Collection Path: New inferences using the HuggingFace Inference API can be made  by easily adding a new document to this collection path.
+- Model ID: The Model ID from [Hugging Face Model Hub](https://huggingface.co/models).
+  Check the [recommended models for each ML task available](https://api-inference.huggingface.co/docs/python/html/detailed_parameters.html#detailed-parameters), or the [Tasks](https://huggingface.co/tasks) overview.
 
-* The task to run the inference on: The task to run the inference on. [Check more in the Hugging Face docs](https://huggingface.co/docs/api-inference/detailed_parameters),  or the [Tasks](https://huggingface.co/tasks) overview.
+- Inference Collection Path: New inferences using the HuggingFace Inference API can be made by easily adding a new document to this collection path.
 
-* Custom Inference Endpoint: If you want to use a custom model hosted on your own server, you can specify the endpoint here.
-
-* Cloud Functions location: Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
+- The task to run the inference on: The task to run the inference on. [Check more in the Hugging Face docs](https://huggingface.co/docs/api-inference/detailed_parameters), or the [Tasks](https://huggingface.co/tasks) overview.
 
+- Custom Inference Endpoint: If you want to use a custom model hosted on your own server, you can specify the endpoint here.
 
+- Cloud Functions location: Where do you want to deploy the functions created for this extension? For help selecting a location, refer to the [location selection guide](https://firebase.google.com/docs/functions/locations).
 
 **Cloud Functions:**
 
-* **triggerInference:** Firestore onCreate-triggered function that run an inference on ${param:MODEL_ID} when a new  document is created in the collection ${param:COLLECTION_PATH}
-
-
+- **triggerInference:** Firestore onCreate-triggered function that run an inference on ${param:MODEL_ID} when a new document is created in the collection ${param:COLLECTION_PATH}
 
 **Access Required**:
 
-
-
 This extension will operate with the following project IAM roles:
 
-* datastore.user (Reason: This role is required to read/write from the Cloud Firestore database.)
+- datastore.user (Reason: This role is required to read/write from the Cloud Firestore database.)

extensions/firestore-huggingface-inference-api/extension.yaml

@@ -27,22 +27,13 @@ roles:
     reason: This role is required to read/write from the Cloud Firestore database.
 
 resources:
-  # - name: runInference
-  #   type: firebaseextensions.v1beta.function
-  #   description: >-
-  #     HTTP call-triggered function that run an inference on ${params:MODEL_ID}
-  #   properties:
-  #     location: ${LOCATION}
-  #     runtime: 'nodejs16'
-  #     httpsTrigger: {}
-
   - name: triggerInference
     type: firebaseextensions.v1beta.function
     description: >-
       Firestore onCreate-triggered function that run an inference on ${param:MODEL_ID} when a new 
       document is created in the collection ${param:COLLECTION_PATH}
     properties:
-      location: ${LOCATION}
+      location: ${param:LOCATION}
       runtime: 'nodejs18'
       eventTrigger:
         eventType: providers/cloud.firestore/eventTypes/document.write

extensions/firestore-huggingface-inference-api/functions/package.json

@@ -30,4 +30,4 @@
     "typescript": "^4.9.0"
   },
   "private": true
-}
+}