Create README.md

README.md

@@ -0,0 +1,16 @@
+---
+license: mit
+---
+# Dreamsim local checkpoints
+all checkpoints needed to run dreamsim locally, verified on commit [2b3e78e](https://github.com/ssundaram21/dreamsim/commit/2b3e78ee4c104257bbed4a4c9084d4b30fe1665c)
+
+## download
+use git to download files to local
+
+## run
+
+```python
+from dreamsim import dreamsim
+model, preprocess = dreamsim(pretrained=True, device=self.device, cache_dir="/path/to/dreamsim_ckpts")
+dist = model(tensor_a, tensor_b).item()
+```