Add explicit notes that the docs directory is unreliable (#922)

Jack-Khuu · web-flow · commit be2c8ed9bdae · 2024-07-18T09:36:11.000-07:00
diff --git a/README.md b/README.md
@@ -437,7 +437,7 @@ We provide
 
 ## Community Contributions
 
-We really value our community and the contributions made by our wonderful users. We'll use this section to call out some of these contributions! If you'd like to help out as well, please see the [CONTRIBUTING](docs/CONTRIBUTING.md) guide.
+We really value our community and the contributions made by our wonderful users. We'll use this section to call out some of these contributions! If you'd like to help out as well, please see the [CONTRIBUTING](CONTRIBUTING.md) guide.
 
 ## Troubleshooting
 
@@ -472,7 +472,7 @@ solely responsible for complying with all such obligations.
 
 
 ## Acknowledgements
-Thank you to the [community](docs/ACKNOWLEDGEMENTS.md) for all the
+Thank you to the community for all the
 awesome libraries and tools you've built around local LLM inference.
 
 * Georgi Gerganov and his [GGML](https://github.com/ggerganov/ggml)
diff --git a/docs/ACKNOWLEDGEMENTS.md b/docs/ACKNOWLEDGEMENTS.md
diff --git a/docs/ADVANCED-USERS.md b/docs/ADVANCED-USERS.md
@@ -1,3 +1,6 @@
+> [!WARNING]
+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.
+
 # Torchchat is still in pre-release!
 
 
@@ -215,7 +218,7 @@ adapted to support other models, either by extending the model
 description in `model.py` or by initializing a completely different
 model.  *We invite and welcome community contributions of open-source
 model enablement to torchchat, as well as to our related open source
-projects PyTorch, ExecuTorch (for mobile/edge models), torchao 
+projects PyTorch, ExecuTorch (for mobile/edge models), torchao
 (for architecture optimization) and other
 PyTorch projects.* (Please refer to individual projects for specific
 submission guidelines.)
diff --git a/docs/Android.md b/docs/Android.md
@@ -1,3 +1,6 @@
+> [!WARNING]
+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.
+
 # Executing LLM models on Android
 
 ## Option 1: Use ExecuTorch LLAMA Demo App
diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md
@@ -1,3 +1,7 @@
+> [!WARNING]
+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.
+
+
 # Contributing to torchchat
 We want to make contributing to this project as easy and transparent as possible.
 
diff --git a/docs/GGUF.md b/docs/GGUF.md
@@ -1,3 +1,6 @@
+> [!WARNING]
+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.
+
 # Using GGUF Models
 
 <!--
@@ -99,7 +102,7 @@ ${GGUF}/quantize --allow-requantize path_of_model_you_are_converting_from.gguf p
 
 For example, to convert the quantized model you downloaded above to an FP16 model, you would execute:
 ```
-${GGUF}/quantize --allow-requantize ${GGUF_MODEL_PATH} ./open_orca_fp16.gguf fp16   
+${GGUF}/quantize --allow-requantize ${GGUF_MODEL_PATH} ./open_orca_fp16.gguf fp16
 ```
 
 After the model is converted to a supported format like FP16, you can proceed using the instructions above.
diff --git a/docs/Models.md b/docs/Models.md
@@ -1,3 +1,6 @@
+> [!WARNING]
+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.
+
 # Models
 
 These are the supported models
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,6 @@
+# Docs in this directory are unstable
+
+Explicitly calling out that the docs in this directory may be outdated, incomplete, scratch notes, or a WIP.
+torchchat provides no guarantees on these files as references.
+
+Please refer to the root README for stable features and documentation.
diff --git a/docs/evaluation.md b/docs/evaluation.md
@@ -1,3 +1,5 @@
+> [!WARNING]
+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.
 
 
 # Evaluation Features
diff --git a/docs/executorch_setup.md b/docs/executorch_setup.md
@@ -1,3 +1,6 @@
+> [!WARNING]
+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.
+
 # Set-up ExecuTorch
 
 Before running any commands in torchchat that require ExecuTorch, you
@@ -14,4 +17,4 @@ export TORCHCHAT_ROOT=$PWD
 This will download the ExecuTorch repo to ./et-build/src and install
 various ExecuTorch libraries to ./et-build/install.
 
-[end default]: end
+[end default]: end
diff --git a/docs/iOS.md b/docs/iOS.md
@@ -1,3 +1,6 @@
+> [!WARNING]
+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.
+
 # Running LLaMA models on iOS
 
 On a Mac set-up [ExecuTorch](executorch_setup.md) and open the LLaMA app project with Xcode:
diff --git a/docs/native-execution.md b/docs/native-execution.md
@@ -1,3 +1,6 @@
+> [!WARNING]
+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.
+
 # Native Execution
 
 [shell default]: ./install_requirements.sh
diff --git a/docs/quantization.md b/docs/quantization.md
@@ -1,3 +1,6 @@
+> [!WARNING]
+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.
+
 
 # Quantization
 
@@ -133,7 +136,7 @@ python3 export.py --dtype [ fast16 | fast | bf16 | fp16 | fp32] ...
 ```
 [skip default]: end
 
-Unlike gpt-fast which uses bfloat16 as default, torchchat uses the dtype "fast16" as the default. Torchchat will pick the appropriate 16-bit floating point type available and offering the best performance (for execution with Executorch, macOS/ARM and Linux/x86 platforms).  For macOS, support depends on the OS version, with versions starting with 14.0 supporting bfloat16 as support, and float16 for earlier OS version based on system support for these data types.  
+Unlike gpt-fast which uses bfloat16 as default, torchchat uses the dtype "fast16" as the default. Torchchat will pick the appropriate 16-bit floating point type available and offering the best performance (for execution with Executorch, macOS/ARM and Linux/x86 platforms).  For macOS, support depends on the OS version, with versions starting with 14.0 supporting bfloat16 as support, and float16 for earlier OS version based on system support for these data types.
 
 Support for FP16 and BF16 is limited in many embedded processors and -dtype fp32 may be required in some environments. Additional ExecuTorch support for 16-bit floating point types may be added in the future based on hardware support.
 

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+> [!WARNING]`
	`2`	`+> Files in this directory may be outdated, incomplete, scratch notes, or a WIP. torchchat provides no guarantees on these files as references. Please refer to the root README for stable features and documentation.`
`1`	`3`
`2`	`4`
`3`	`5`	`# Evaluation Features`