Promote new docs (#3659)

* Moved old docs to legacy Signed-off-by: Hitarth Mehta <quic_hitameht@quicinc.com> * Promote beta docs Signed-off-by: Hitarth Mehta <quic_hitameht@quicinc.com> * Exclude legacy directory, CMakeLists.txt changes Signed-off-by: Hitarth Mehta <quic_hitameht@quicinc.com> * Fix the relative paths Signed-off-by: Hitarth Mehta <quic_hitameht@quicinc.com> * Restructure TF, ONNX quantsim guide Signed-off-by: Hitarth Mehta <quic_hitameht@quicinc.com> * Add aimet paths for autodoc Signed-off-by: Hitarth Mehta <quic_hitameht@quicinc.com> * Temporarily disable autosummary Signed-off-by: Hitarth Mehta <quic_hitameht@quicinc.com> * Enable autosummary Signed-off-by: Hitarth Mehta <quic_hitameht@quicinc.com> --------- Signed-off-by: Hitarth Mehta <quic_hitameht@quicinc.com>
quic · Dec 18, 2024 · 8a9aef0 · 8a9aef0
1 parent d8c67af
commit 8a9aef0
Show file tree

Hide file tree

Showing 255 changed files with 1,736 additions and 1,104 deletions.
diff --git a/Docs/CMakeLists.txt b/Docs/CMakeLists.txt
@@ -2,7 +2,7 @@
 #
 #  @@-COPYRIGHT-START-@@
 #  
-#  Copyright (c) 2018, Qualcomm Innovation Center, Inc. All rights reserved.
+#  Copyright (c) 2018-2024, Qualcomm Innovation Center, Inc. All rights reserved.
 #  
 #  Redistribution and use in source and binary forms, with or without 
 #  modification, are permitted provided that the following conditions are met:
@@ -54,12 +54,3 @@ add_dependencies(doc
 
 add_custom_target(copy_doc_source
     COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_SOURCE_DIR} ${CMAKE_BINARY_DIR}/Docs_SOURCE)
-
-add_custom_target(doc_beta
-      COMMAND ${CMAKE_COMMAND} -E env
-      "${AIMET_PYTHONPATH}"
-      "SW_VERSION=${SW_VERSION}"
-      sphinx-build -v -T -b html ${CMAKE_BINARY_DIR}/Docs_SOURCE/beta ${CMAKE_CURRENT_BINARY_DIR}/beta -c ${CMAKE_BINARY_DIR}/Docs_SOURCE/beta)
-
-add_dependencies(doc_beta
-    copy_doc_source copy_examples_beta_docs)
diff --git a/Docs/beta/_static/aimet-furo.css → Docs/_static/aimet-furo.css b/Docs/beta/_static/aimet-furo.css → Docs/_static/aimet-furo.css
diff --git a/Docs/beta/_templates/class.rst → Docs/_templates/class.rst b/Docs/beta/_templates/class.rst → Docs/_templates/class.rst
diff --git a/Docs/beta/_templates/function.rst → Docs/_templates/function.rst b/Docs/beta/_templates/function.rst → Docs/_templates/function.rst
diff --git a/...beta/_templates/sidebar/doc_versions.html → Docs/_templates/sidebar/doc_versions.html b/...beta/_templates/sidebar/doc_versions.html → Docs/_templates/sidebar/doc_versions.html
diff --git a/Docs/beta/_templates/sidebar/navigation.html → Docs/_templates/sidebar/navigation.html b/Docs/beta/_templates/sidebar/navigation.html → Docs/_templates/sidebar/navigation.html
diff --git a/Docs/beta/abbreviation.txt → Docs/abbreviation.txt b/Docs/beta/abbreviation.txt → Docs/abbreviation.txt
diff --git a/Docs/beta/apiref/index.rst → Docs/apiref/index.rst b/Docs/beta/apiref/index.rst → Docs/apiref/index.rst
diff --git a/Docs/beta/apiref/onnx/adaround.rst → Docs/apiref/onnx/adaround.rst b/Docs/beta/apiref/onnx/adaround.rst → Docs/apiref/onnx/adaround.rst
diff --git a/Docs/beta/apiref/onnx/amp.rst → Docs/apiref/onnx/amp.rst b/Docs/beta/apiref/onnx/amp.rst → Docs/apiref/onnx/amp.rst
diff --git a/Docs/beta/apiref/onnx/autoquant.rst → Docs/apiref/onnx/autoquant.rst b/Docs/beta/apiref/onnx/autoquant.rst → Docs/apiref/onnx/autoquant.rst
diff --git a/Docs/beta/apiref/onnx/bnf.rst → Docs/apiref/onnx/bnf.rst b/Docs/beta/apiref/onnx/bnf.rst → Docs/apiref/onnx/bnf.rst
diff --git a/Docs/beta/apiref/onnx/cle.rst → Docs/apiref/onnx/cle.rst b/Docs/beta/apiref/onnx/cle.rst → Docs/apiref/onnx/cle.rst
diff --git a/Docs/beta/apiref/onnx/index.rst → Docs/apiref/onnx/index.rst b/Docs/beta/apiref/onnx/index.rst → Docs/apiref/onnx/index.rst
diff --git a/...a/apiref/onnx/layer_output_generation.rst → Docs/apiref/onnx/layer_output_generation.rst b/...a/apiref/onnx/layer_output_generation.rst → Docs/apiref/onnx/layer_output_generation.rst
diff --git a/Docs/beta/apiref/onnx/lpbq.rst → Docs/apiref/onnx/lpbq.rst b/Docs/beta/apiref/onnx/lpbq.rst → Docs/apiref/onnx/lpbq.rst
diff --git a/Docs/beta/apiref/onnx/quant_analyzer.rst → Docs/apiref/onnx/quant_analyzer.rst b/Docs/beta/apiref/onnx/quant_analyzer.rst → Docs/apiref/onnx/quant_analyzer.rst
diff --git a/Docs/beta/apiref/onnx/quantsim.rst → Docs/apiref/onnx/quantsim.rst b/Docs/beta/apiref/onnx/quantsim.rst → Docs/apiref/onnx/quantsim.rst
diff --git a/Docs/beta/apiref/onnx/seq_mse.rst → Docs/apiref/onnx/seq_mse.rst b/Docs/beta/apiref/onnx/seq_mse.rst → Docs/apiref/onnx/seq_mse.rst
diff --git a/Docs/beta/apiref/tensorflow/adaround.rst → Docs/apiref/tensorflow/adaround.rst b/Docs/beta/apiref/tensorflow/adaround.rst → Docs/apiref/tensorflow/adaround.rst
diff --git a/Docs/beta/apiref/tensorflow/amp.rst → Docs/apiref/tensorflow/amp.rst b/Docs/beta/apiref/tensorflow/amp.rst → Docs/apiref/tensorflow/amp.rst
diff --git a/Docs/beta/apiref/tensorflow/autoquant.rst → Docs/apiref/tensorflow/autoquant.rst b/Docs/beta/apiref/tensorflow/autoquant.rst → Docs/apiref/tensorflow/autoquant.rst
diff --git a/Docs/beta/apiref/tensorflow/bn.rst → Docs/apiref/tensorflow/bn.rst b/Docs/beta/apiref/tensorflow/bn.rst → Docs/apiref/tensorflow/bn.rst
diff --git a/Docs/beta/apiref/tensorflow/bnf.rst → Docs/apiref/tensorflow/bnf.rst b/Docs/beta/apiref/tensorflow/bnf.rst → Docs/apiref/tensorflow/bnf.rst
diff --git a/Docs/beta/apiref/tensorflow/cle.rst → Docs/apiref/tensorflow/cle.rst b/Docs/beta/apiref/tensorflow/cle.rst → Docs/apiref/tensorflow/cle.rst
diff --git a/Docs/beta/apiref/tensorflow/compress.rst → Docs/apiref/tensorflow/compress.rst b/Docs/beta/apiref/tensorflow/compress.rst → Docs/apiref/tensorflow/compress.rst
diff --git a/Docs/beta/apiref/tensorflow/index.rst → Docs/apiref/tensorflow/index.rst b/Docs/beta/apiref/tensorflow/index.rst → Docs/apiref/tensorflow/index.rst
diff --git a/...ef/tensorflow/layer_output_generation.rst → ...ef/tensorflow/layer_output_generation.rst b/...ef/tensorflow/layer_output_generation.rst → ...ef/tensorflow/layer_output_generation.rst
diff --git a/...beta/apiref/tensorflow/quant_analyzer.rst → Docs/apiref/tensorflow/quant_analyzer.rst b/...beta/apiref/tensorflow/quant_analyzer.rst → Docs/apiref/tensorflow/quant_analyzer.rst
diff --git a/Docs/beta/apiref/tensorflow/quantsim.rst → Docs/apiref/tensorflow/quantsim.rst b/Docs/beta/apiref/tensorflow/quantsim.rst → Docs/apiref/tensorflow/quantsim.rst
diff --git a/Docs/beta/apiref/torch/adaround.rst → Docs/apiref/torch/adaround.rst b/Docs/beta/apiref/torch/adaround.rst → Docs/apiref/torch/adaround.rst
diff --git a/Docs/beta/apiref/torch/amp.rst → Docs/apiref/torch/amp.rst b/Docs/beta/apiref/torch/amp.rst → Docs/apiref/torch/amp.rst
diff --git a/Docs/beta/apiref/torch/autoquant.rst → Docs/apiref/torch/autoquant.rst b/Docs/beta/apiref/torch/autoquant.rst → Docs/apiref/torch/autoquant.rst
diff --git a/Docs/beta/apiref/torch/bn.rst → Docs/apiref/torch/bn.rst b/Docs/beta/apiref/torch/bn.rst → Docs/apiref/torch/bn.rst
diff --git a/Docs/beta/apiref/torch/bnf.rst → Docs/apiref/torch/bnf.rst b/Docs/beta/apiref/torch/bnf.rst → Docs/apiref/torch/bnf.rst
diff --git a/Docs/beta/apiref/torch/cle.rst → Docs/apiref/torch/cle.rst b/Docs/beta/apiref/torch/cle.rst → Docs/apiref/torch/cle.rst
diff --git a/Docs/beta/apiref/torch/compress.rst → Docs/apiref/torch/compress.rst b/Docs/beta/apiref/torch/compress.rst → Docs/apiref/torch/compress.rst
diff --git a/Docs/beta/apiref/torch/index.rst → Docs/apiref/torch/index.rst b/Docs/beta/apiref/torch/index.rst → Docs/apiref/torch/index.rst
diff --git a/.../apiref/torch/layer_output_generation.rst → .../apiref/torch/layer_output_generation.rst b/.../apiref/torch/layer_output_generation.rst → .../apiref/torch/layer_output_generation.rst
diff --git a/Docs/beta/apiref/torch/model_preparer.rst → Docs/apiref/torch/model_preparer.rst b/Docs/beta/apiref/torch/model_preparer.rst → Docs/apiref/torch/model_preparer.rst
diff --git a/Docs/beta/apiref/torch/peft_lora.rst → Docs/apiref/torch/peft_lora.rst b/Docs/beta/apiref/torch/peft_lora.rst → Docs/apiref/torch/peft_lora.rst
diff --git a/Docs/beta/apiref/torch/quant_analyzer.rst → Docs/apiref/torch/quant_analyzer.rst b/Docs/beta/apiref/torch/quant_analyzer.rst → Docs/apiref/torch/quant_analyzer.rst
diff --git a/Docs/beta/apiref/torch/quantsim.rst → Docs/apiref/torch/quantsim.rst b/Docs/beta/apiref/torch/quantsim.rst → Docs/apiref/torch/quantsim.rst
diff --git a/Docs/beta/apiref/torch/seq_mse.rst → Docs/apiref/torch/seq_mse.rst b/Docs/beta/apiref/torch/seq_mse.rst → Docs/apiref/torch/seq_mse.rst
diff --git a/Docs/beta/apiref/torch/v2/adaround.rst → Docs/apiref/torch/v2/adaround.rst b/Docs/beta/apiref/torch/v2/adaround.rst → Docs/apiref/torch/v2/adaround.rst
diff --git a/...ef/torch/v2/interactive_visualization.rst → ...ef/torch/v2/interactive_visualization.rst b/...ef/torch/v2/interactive_visualization.rst → ...ef/torch/v2/interactive_visualization.rst
diff --git a/Docs/beta/apiref/torch/v2/lpbq.rst → Docs/apiref/torch/v2/lpbq.rst b/Docs/beta/apiref/torch/v2/lpbq.rst → Docs/apiref/torch/v2/lpbq.rst
diff --git a/Docs/beta/apiref/torch/v2/mmp.rst → Docs/apiref/torch/v2/mmp.rst b/Docs/beta/apiref/torch/v2/mmp.rst → Docs/apiref/torch/v2/mmp.rst
diff --git a/Docs/beta/apiref/torch/v2/nn.rst → Docs/apiref/torch/v2/nn.rst b/Docs/beta/apiref/torch/v2/nn.rst → Docs/apiref/torch/v2/nn.rst
diff --git a/Docs/beta/apiref/torch/v2/quant_analyzer.rst → Docs/apiref/torch/v2/quant_analyzer.rst b/Docs/beta/apiref/torch/v2/quant_analyzer.rst → Docs/apiref/torch/v2/quant_analyzer.rst
diff --git a/Docs/beta/apiref/torch/v2/quantization.rst → Docs/apiref/torch/v2/quantization.rst b/Docs/beta/apiref/torch/v2/quantization.rst → Docs/apiref/torch/v2/quantization.rst
diff --git a/Docs/beta/apiref/torch/v2/quantsim.rst → Docs/apiref/torch/v2/quantsim.rst b/Docs/beta/apiref/torch/v2/quantsim.rst → Docs/apiref/torch/v2/quantsim.rst
diff --git a/Docs/beta/apiref/torch/v2/seq_mse.rst → Docs/apiref/torch/v2/seq_mse.rst b/Docs/beta/apiref/torch/v2/seq_mse.rst → Docs/apiref/torch/v2/seq_mse.rst
diff --git a/Docs/beta/images/adaround.png b/Docs/beta/images/adaround.png
diff --git a/Docs/beta/images/brain_logo.png b/Docs/beta/images/brain_logo.png
diff --git a/Docs/beta/install/index.rst b/Docs/beta/install/index.rst
diff --git a/Docs/beta/quantsim/onnx/quantsim.rst b/Docs/beta/quantsim/onnx/quantsim.rst
diff --git a/Docs/beta/quantsim/tensorflow/quantsim.rst b/Docs/beta/quantsim/tensorflow/quantsim.rst