add local model tracing docs (#91)

hypermodeinc · Feb 11, 2025 · 099e32f · 099e32f
1 parent b208f1c
commit 099e32f
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/images/observe-functions/local-inference-history.png b/images/observe-functions/local-inference-history.png
diff --git a/modus/quickstart.mdx b/modus/quickstart.mdx
@@ -200,6 +200,20 @@ learn how to use the basic components of a Modus app and how to run it locally.
     This links your project to the Hypermode platform, allowing you to leverage the model in your modus app.
 
   </Step>
+
+  <Step title="Track local model inferences">
+
+    When testing an AI app locally, Modus records the inference and related metadata
+    in the `View Inferences` tab of the APIs explorer.
+
+    <Note>
+      Local model tracing is only supported on Linux and macOS. Windows support is
+      coming soon.
+    </Note>
+
+    ![local model tracing](../images/observe-functions/local-inference-history.png)
+
+  </Step>
 </Steps>
 
 <Tip>

diff --git a/observe-functions.mdx b/observe-functions.mdx
@@ -17,7 +17,7 @@ your functions.
 For more information on recording info, warnings, and errors in your Modus app,
 see [Error Handling](/modus/error-handling).
 
-## Inference history
+## Model tracing
 
 For each model invocation, Hypermode records the model inference and related
 metadata. This includes the input and output of the model, as well as the
@@ -26,4 +26,4 @@ timestamp and duration of the inference.
 From your project, select the Inferences tab to view the inferences from your
 app's models.
 
-![inference history](images/observe-functions/inference-history.png)
+![model tracing](images/observe-functions/inference-history.png)