update: readme + docs

wandb · Jun 21, 2024 · 2c72c4f · 2c72c4f
1 parent fc645f6
commit 2c72c4f
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -2,6 +2,9 @@
 
 Hemm is a library for performing comprehensive benchmark of text-to-image diffusion models on image quality and prompt comprehension integrated with [Weights & Biases](https://wandb.ai/site) and [Weave](https://wandb.github.io/weave/). Hemm is inspired by [Holistic Evaluation of Text-To-Image Models](https://crfm.stanford.edu/helm/heim/v1.0.0/).
 
+> [!WARNING]  
+> Hemm is still in early development, the API is subject to change, expect things to break. If you are interested in contributing, please feel free to open an issue and/or raise a pull request.
+
 ## Installation
 
 ```shell

diff --git a/docs/index.md b/docs/index.md
@@ -2,6 +2,9 @@
 
 Hemm is a library for performing comprehensive benchmark of text-to-image diffusion models on image quality and prompt comprehension integrated with [Weights & Biases](https://wandb.ai/site) and [Weave](https://wandb.github.io/weave/). Hemm is inspired by [Holistic Evaluation of Text-To-Image Models](https://crfm.stanford.edu/helm/heim/v1.0.0/).
 
+!!! warning
+    Hemm is still in early development, the API is subject to change, expect things to break. If you are interested in contributing, please feel free to open an issue and/or raise a pull request.
+
 ## Installation
 
 ```shell

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -48,4 +48,4 @@ nav:
     - Spatial-Relationship: 'metrics/spatial_relationship.md'
   - Utils: 'utils.md'
 
-repo_url: https://github.com/soumik12345/Hemm
+repo_url: https://github.com/wandb/Hemm