docs: auto generated by furiosa-sdk-private#699

related commit: furiosa-ai/furiosa-sdk-private@e0a1b30
furiosa-ai · Aug 3, 2023 · 555c6de · 555c6de
1 parent 4736aee
commit 555c6de
Show file tree

Hide file tree

Showing 61 changed files with 289 additions and 166 deletions.
diff --git a/v0.10.0/en/_sources/software/cli.rst.txt b/v0.10.0/en/_sources/software/cli.rst.txt
@@ -191,11 +191,12 @@ The following is an example usage of furiosa-bench without an output path option
     99th percentile (us): 79874
     99th percentile (us): 307568
   
-If an output path is specified, furiosa-bench will save a json document as the following:
+If an output path is specified, furiosa-bench will save a JSON document as the following:
 
 .. code-block:: sh
 
-  $ furiosa-bench mnist-8.onnx --workload L -n 1000 -w 8 -t 2 -o mnist.json | cat mnist.json
+  $ furiosa-bench mnist-8.onnx --workload L -n 1000 -w 8 -t 2 -o mnist.json
+  $ cat mnist.json
 
     {
         "model_data": {

diff --git a/v0.10.0/en/_sources/software/compiler.rst.txt b/v0.10.0/en/_sources/software/compiler.rst.txt
@@ -76,7 +76,7 @@ The usage of ``furiosa-compiler`` is as the following:
 
 
 ``SOURCE`` is the file path of 
-`TFLite <https://www.tensorflow.org/lite>`_ or `Onnx <https://onnx.ai/>`_.
+`TFLite <https://www.tensorflow.org/lite>`_ or `ONNX <https://onnx.ai/>`_.
 You have to use quantized models through :ref:`ModelQuantization` for NPU accleration.
 
 You can omit the option `-o OUTPUT`, and you can also choose to designate the output file name.

diff --git a/v0.10.0/en/_sources/software/profiler.rst.txt b/v0.10.0/en/_sources/software/profiler.rst.txt
@@ -1,7 +1,7 @@
 .. _Profiling:
 
 ***********************************
-Performance profiling
+Performance Profiling
 ***********************************
 
 Low latency and high throughput performance are critical factors in many DNN applications.
@@ -19,7 +19,7 @@ It is thus not enabled by default. You can create trace by using one of the foll
 
 .. _ProfilerEnabledByEnv:
 
-Tracing Enabled by Environmet Variable
+Tracing via Environment Variable
 ============================================================
 You can enable trace generation by setting the path of the file to which the trace result will be written in ``FURIOSA_PROFILER_OUTPUT_PATH``. The advantage of this method is that the code remains unchanged. The downside is that you cannot set a specific section or category for measurement.
 
@@ -51,7 +51,7 @@ If you enter ``chrome://tracing`` in Chrome's address bar, the trace viewer will
 
 .. _ProfilerEnabledByContext:
 
-Tracing Enabled by Profiler Context
+Tracing via Profiler Context
 ============================================================
 You can also trace a model inference performance by using a Profiler Context in your Python code. The advantages of this method, in comparison to the tracing by environment variable, are as follows:
 

diff --git a/v0.10.0/en/api/python/furiosa.common.html b/v0.10.0/en/api/python/furiosa.common.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.common.transport.html b/v0.10.0/en/api/python/furiosa.common.transport.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.optimizer.frontend.html b/v0.10.0/en/api/python/furiosa.optimizer.frontend.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.optimizer.frontend.onnx.html b/v0.10.0/en/api/python/furiosa.optimizer.frontend.onnx.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.optimizer.frontend.onnx.transformer.experimental.html b/v0.10.0/en/api/python/furiosa.optimizer.frontend.onnx.transformer.experimental.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.optimizer.frontend.onnx.transformer.html b/v0.10.0/en/api/python/furiosa.optimizer.frontend.onnx.transformer.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.optimizer.frontend.onnx.utils.html b/v0.10.0/en/api/python/furiosa.optimizer.frontend.onnx.utils.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.optimizer.html b/v0.10.0/en/api/python/furiosa.optimizer.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.optimizer.interfaces.html b/v0.10.0/en/api/python/furiosa.optimizer.interfaces.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.quantizer.html b/v0.10.0/en/api/python/furiosa.quantizer.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.runtime.html b/v0.10.0/en/api/python/furiosa.runtime.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.server.api.cli.html b/v0.10.0/en/api/python/furiosa.server.api.cli.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.server.api.grpc.generated.html b/v0.10.0/en/api/python/furiosa.server.api.grpc.generated.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.server.api.grpc.html b/v0.10.0/en/api/python/furiosa.server.api.grpc.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.server.api.html b/v0.10.0/en/api/python/furiosa.server.api.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.server.api.rest.html b/v0.10.0/en/api/python/furiosa.server.api.rest.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.server.handlers.html b/v0.10.0/en/api/python/furiosa.server.handlers.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>

diff --git a/v0.10.0/en/api/python/furiosa.server.html b/v0.10.0/en/api/python/furiosa.server.html
@@ -62,7 +62,7 @@
 <li class="toctree-l1"><a class="reference internal" href="../../software/cli.html">Command Line Tools</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/compiler.html">Compiler</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/quantization.html">Model Quantization</a></li>
-<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance profiling</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../../software/profiler.html">Performance Profiling</a></li>
 <li class="toctree-l1"><a class="reference external" href="https://furiosa-ai.github.io/furiosa-models/latest/">FuriosaAI Model Zoo</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/serving.html">Model Server (Serving Framework)</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../../software/kubernetes_support.html">Kubernetes Support</a></li>