docs: add state note

phpcws · Dec 26, 2023 · 17a4c6d · 17a4c6d
1 parent 721d972
commit 17a4c6d
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/docs/docs/guides/04-using-models/02-import-manually.mdx b/docs/docs/guides/04-using-models/02-import-manually.mdx
@@ -109,6 +109,8 @@ Copy the following configurations into the `model.json`.
 2. Make sure the `source_url` property is the direct binary download link ending in `.gguf`. In HuggingFace, you can find the directl links in `Files and versions` tab.
 3. Ensure you are using the correct `prompt_template`. This is usually provided in the HuggingFace model's description page.
 
+> Note: Currently, the filename must be `model.json` and the ID has to be equal to the foldername. In the `model.json`, you have to include the `state` property and set it to `ready` for Jan to recognize the model.
+
 ```js
 {
     "source_url": "https://huggingface.co/janhq/trinity-v1-GGUF/resolve/main/trinity-v1.Q4_K_M.gguf",