Update README.md

README.md

@@ -12,6 +12,92 @@ metrics:
 - rouge
 language:
 - en
+examples:
+  - text: |
+      import torch
+      from transformers import AutoTokenizer, AutoModelForSequenceClassification
+
+      checkpoint = "distilbert-base-uncased-finetuned-sst-2-english"
+      tokenizer = AutoTokenizer.from_pretrained(checkpoint)
+      model = AutoModelForSequenceClassification.from_pretrained(checkpoint)
+      sequences = ["I've been waiting for a HuggingFace course my whole life.", "So have I!"]
+
+      tokens = tokenizer(sequences, padding=True, truncation=True, return_tensors="pt")
+      output = model(**tokens)
+    example_title: Example One
+
+  - text: |
+      import torch
+      from tqdm.auto import tqdm
+
+      device = torch.device("cuda") if torch.cuda.is_available() else torch.device("cpu")
+      model.to(device)
+
+      progress_bar = tqdm(range(num_training_steps))
+
+      model.train()
+      for epoch in range(num_epochs):
+          for batch in train_dataloader:
+              batch = {k: v.to(device) for k, v in batch.items()}
+              outputs = model(**batch)
+              loss = outputs.loss
+              loss.backward()
+
+              optimizer.step()
+              lr_scheduler.step()
+              optimizer.zero_grad()
+              progress_bar.update(1)
+    example_title: Example Two
+
+  - text: |
+      import evaluate
+
+      metric = evaluate.load("glue", "mrpc")
+      model.eval()
+      for batch in eval_dataloader:
+          batch = {k: v.to(device) for k, v in batch.items()}
+          with torch.no_grad():
+              outputs = model(**batch)
+
+          logits = outputs.logits
+          predictions = torch.argmax(logits, dim=-1)
+          metric.add_batch(predictions=predictions, references=batch["labels"])
+
+      metric.compute()
+    example_title: Example Three
+
+  - text: |
+      git lfs install
+      huggingface-cli lfs-enable-largefiles .
+      git lfs track "*.bin"
+      git add .
+      git commit -a -m "add fp32 chkpt"
+      git push
+    example_title: Example Four
+
+  - text: |
+      export interface DocumentParams {
+        pageContent: string;
+
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        metadata: Record<string, any>;
+      }
+
+      /**
+       * Interface for interacting with a document.
+       */
+      export class Document implements DocumentParams {
+        pageContent: string;
+
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        metadata: Record<string, any>;
+
+        constructor(fields?: Partial<DocumentParams>) {
+          this.pageContent = fields?.pageContent ?? this.pageContent;
+          this.metadata = fields?.metadata ?? {};
+        }
+      }
+    example_title: Example Five
 inference:
   parameters:
     max_length: 128