Skip to content

Commit

Permalink
docs(frontend): addressing comments
Browse files Browse the repository at this point in the history
  • Loading branch information
yuxizama committed Aug 27, 2024
1 parent 3e0fb2c commit 5bf10ee
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/execution-analysis/debug.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Debug

This document provides guidance on debugging the compilation process
This document provides guidance on debugging the compilation process.

## Compiler debug and verbose modes

Two [configuration](../guides/configure.md) options are available to help you understand the compilation process:
Two [configuration](../guides/configure.md) options are available to help you understand the compilation process:

* **compiler\_verbose\_mode**: Prints the compiler passes and shows the transformations applied. It can help identify the crash location if a crash occurs.
* **compiler\_debug\_mode**: A more detailed version of the verbose mode, providing additional information, particularly useful for diagnosing crashes.
Expand All @@ -25,7 +25,7 @@ def f(x):
return np.sin(x)
```

This function fails to compile because **Concrete** does not support floating-point outputs. When you try to compile it, an exception will be raised and the artifacts will be exported automatically. The the following files will be generated in the `.artifacts` directory:
This function fails to compile because **Concrete** does not support floating-point outputs. When you try to compile it, an exception will be raised and the artifacts will be exported automatically. The following files will be generated in the `.artifacts` directory:

- **`environment.txt`**: Information about your system setup, including the operating system and Python version.

Expand Down Expand Up @@ -279,8 +279,8 @@ If you cannot find a solution in the community forum, or if you have found a bug

For [bug reports](https://github.com/zama-ai/concrete/issues/new?assignees=&labels=bug%2C+triage&projects=&template=bug_report.md), try to:

* Minimize randomness
* Simplify your function while keeping the bug to expedite the fix
* Avoid randomness to ensure reproductibility of the bug
* Minimize your function while keeping the bug to expedite the fix
* Include your input-set in the issue
* Provide clear reproduction steps
* Include debug artifacts in the issue
Expand Down

0 comments on commit 5bf10ee

Please sign in to comment.