Update README.md

README.md

@@ -1,11 +1,16 @@
 ---
 library_name: transformers
-tags: []
+language:
+- en
+- zh
+base_model:
+- superb/wav2vec2-base-superb-sid
 ---
 
 # Model Card for Model ID
 
-<!-- Provide a quick summary of what the model is/does. -->
+The model is intended to speaker identification for audio segments taken from the Mandarin Monkey podcast.
+It was created based the speakerbox code. https://councildataproject.org/speakerbox/
 
 
 
@@ -17,54 +22,42 @@ tags: []
 
 This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-
-### Model Sources [optional]
-
-<!-- Provide the basic links for the model. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
+- **Developed by:** jdalegonzalez
+- **Funded by [optional]:** None. sigh
+- **Model type:** Wave2Vec audio classifier
+- **Language(s) (NLP):** English and Chinese
+- **License:** Meh?
+- **Finetuned from model:** superb/wav2vec2-base-superb-sid
 
 ## Uses
 
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
+Right now, the only thing the model will do is identify which speaker (between the two hosts of Mandarin Monkey)
+is likely speaking a specific audio clip.  In the future, it could be expanded to support
+more speakers, more podcasts, etc...
 
 ### Direct Use
 
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-
-[More Information Needed]
-
-### Downstream Use [optional]
-
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
+I'm not sure what direct use is possible other than diarizing a Mandarin Monkey podcast.
 
 [More Information Needed]
 
 ### Out-of-Scope Use
 
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
+Really, almost any use other than identifying which host is speaking a particular
+audio clip is out-of-scope.
 
 [More Information Needed]
 
 ## Bias, Risks, and Limitations
 
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+There is no warranty expressed or implied.  It works for me.  It may do 
+nothing for you.  This is experimental and shouldn't be the basis
+for any commericial activity.
 
 [More Information Needed]
 
 ### Recommendations
 
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-
 Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
 ## How to Get Started with the Model
@@ -180,16 +173,6 @@ Carbon emissions can be estimated using the [Machine Learning Impact calculator]
 
 [More Information Needed]
 
-## Glossary [optional]
-
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-
-[More Information Needed]
-
-## More Information [optional]
-
-[More Information Needed]
-
 ## Model Card Authors [optional]
 
 [More Information Needed]