chore(docs): Noir Profiler external documentation #7457

vezenovm · 2025-02-20T14:42:17Z

Description

Problem*

Resolves #6410

Summary*

Currently leaving as a draft as this is blocking by releasing noir-profiler binaries and enabling their installation through noirup.

Additional Context

Documentation*

Check one:

No documentation needed.
Documentation included in this PR.
[For Experimental Features] Documentation to be submitted in a separate PR.

PR Checklist*

I have tested the changes locally.
I have formatted the changes with Prettier and/or cargo fmt on default settings.

github-actions

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Test Suite Duration'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite	Current: `e16158a`	Previous: `8783e48`	Ratio
`noir-lang_noir_bigcurve_`	`372` s	`282` s	`1.32`

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

github-actions · 2025-02-20T15:15:59Z

🚀 Deployed on https://67b7659c86ca011cd5c96f98--noir-docs.netlify.app

docs/docs/tooling/profiler.md

github-actions · 2025-02-20T17:26:57Z

FYI @noir-lang/developerrelations on Noir doc changes.

TomAFrench · 2025-02-20T18:14:25Z

LGTM, I'm marking this as ready for review as noir-profiler will be installed through noirup very soon.

chore: remove `disable_macros` compile option (noir-lang/noir#7468) chore(ci): add workflow to automate bumping aztec-packages commit (noir-lang/noir#7465) chore: Release Noir(1.0.0-beta.3) (noir-lang/noir#7346) chore(ci): Missing dash in profiler command argument (noir-lang/noir#7467) feat(experimental): show macro errors where they happen (noir-lang/noir#7333) feat: optimize FieldElement::num_bits (noir-lang/noir#7147) chore(profiler): Docs on profiler command and more complete error reporting (noir-lang/noir#7436) feat(ci): Release noir-inspector in binaries (noir-lang/noir#7464) chore(docs): Noir Profiler external documentation (noir-lang/noir#7457) feat(ci): Publish binaries for noir-profiler (noir-lang/noir#7443) chore: Copy #7387 docs into v1.0.0-beta.2 versioned_docs (noir-lang/noir#7458) fix: prevent incorrect ACIRgen caused by noop truncations (noir-lang/noir#7456) feat: add native `u128` type (noir-lang/noir#7301) chore: standardize that doc comments on top of statements and expression are allowed but warn (noir-lang/noir#7450) fix: don't let nargo fmt produce multiple trailing newlines (noir-lang/noir#7444)

* master: (89 commits) chore: bump external pinned commits (#7472) chore: remove `disable_macros` compile option (#7468) chore(ci): add workflow to automate bumping aztec-packages commit (#7465) chore: Release Noir(1.0.0-beta.3) (#7346) chore(ci): Missing dash in profiler command argument (#7467) feat(experimental): show macro errors where they happen (#7333) feat: optimize FieldElement::num_bits (#7147) chore(profiler): Docs on profiler command and more complete error reporting (#7436) feat(ci): Release noir-inspector in binaries (#7464) chore(docs): Noir Profiler external documentation (#7457) feat(ci): Publish binaries for noir-profiler (#7443) chore: Copy #7387 docs into v1.0.0-beta.2 versioned_docs (#7458) fix: prevent incorrect ACIRgen caused by noop truncations (#7456) feat: add native `u128` type (#7301) chore: standardize that doc comments on top of statements and expression are allowed but warn (#7450) fix: don't let nargo fmt produce multiple trailing newlines (#7444) feat(cli): add noir-execute binary (#7384) chore!: make `ResolverError::OracleMarkedAsConstrained` into a full error (#7426) chore: simplify reports (#7421) fix: do not discard negative sign from field literals in comptime interpreter (#7439) ...

fix: don't panic when shifting too much (noir-lang/noir#7429) chore: bump external pinned commits (noir-lang/noir#7472) chore: remove `disable_macros` compile option (noir-lang/noir#7468) chore(ci): add workflow to automate bumping aztec-packages commit (noir-lang/noir#7465) chore: Release Noir(1.0.0-beta.3) (noir-lang/noir#7346) chore(ci): Missing dash in profiler command argument (noir-lang/noir#7467) feat(experimental): show macro errors where they happen (noir-lang/noir#7333) feat: optimize FieldElement::num_bits (noir-lang/noir#7147) chore(profiler): Docs on profiler command and more complete error reporting (noir-lang/noir#7436) feat(ci): Release noir-inspector in binaries (noir-lang/noir#7464) chore(docs): Noir Profiler external documentation (noir-lang/noir#7457) feat(ci): Publish binaries for noir-profiler (noir-lang/noir#7443) chore: Copy #7387 docs into v1.0.0-beta.2 versioned_docs (noir-lang/noir#7458) fix: prevent incorrect ACIRgen caused by noop truncations (noir-lang/noir#7456) feat: add native `u128` type (noir-lang/noir#7301) chore: standardize that doc comments on top of statements and expression are allowed but warn (noir-lang/noir#7450) fix: don't let nargo fmt produce multiple trailing newlines (noir-lang/noir#7444)

Automated pull of development from the [noir](https://github.com/noir-lang/noir) programming language, a dependency of Aztec. BEGIN_COMMIT_OVERRIDE feat: Sync from aztec-packages (noir-lang/noir#7474) fix: don't panic when shifting too much (noir-lang/noir#7429) chore: bump external pinned commits (noir-lang/noir#7472) chore: remove `disable_macros` compile option (noir-lang/noir#7468) chore(ci): add workflow to automate bumping aztec-packages commit (noir-lang/noir#7465) chore: Release Noir(1.0.0-beta.3) (noir-lang/noir#7346) chore(ci): Missing dash in profiler command argument (noir-lang/noir#7467) feat(experimental): show macro errors where they happen (noir-lang/noir#7333) feat: optimize FieldElement::num_bits (noir-lang/noir#7147) chore(profiler): Docs on profiler command and more complete error reporting (noir-lang/noir#7436) feat(ci): Release noir-inspector in binaries (noir-lang/noir#7464) chore(docs): Noir Profiler external documentation (noir-lang/noir#7457) feat(ci): Publish binaries for noir-profiler (noir-lang/noir#7443) chore: Copy #7387 docs into v1.0.0-beta.2 versioned_docs (noir-lang/noir#7458) fix: prevent incorrect ACIRgen caused by noop truncations (noir-lang/noir#7456) feat: add native `u128` type (noir-lang/noir#7301) chore: standardize that doc comments on top of statements and expression are allowed but warn (noir-lang/noir#7450) fix: don't let nargo fmt produce multiple trailing newlines (noir-lang/noir#7444) END_COMMIT_OVERRIDE --------- Co-authored-by: Tom French <tom@tomfren.ch>

vezenovm added 2 commits February 20, 2025 04:41

noir-profiler documentation

4656b6e

some cleanup and add title

a318104

github-actions bot added the documentation Improvements or additions to documentation label Feb 20, 2025

vezenovm changed the title ~~chore(docs): Noir Porfiler external documentation~~ chore(docs): Noir Profiler external documentation Feb 20, 2025

vezenovm added 2 commits February 20, 2025 14:48

rename graph files

f2a95dd

tags -> description

e16158a

github-actions bot reviewed Feb 20, 2025

View reviewed changes

Merge branch 'master' into mv/profiler-docs

9c7e54c

TomAFrench reviewed Feb 20, 2025

View reviewed changes

docs/docs/tooling/profiler.md Outdated Show resolved Hide resolved

mention being able to click through graph in the browser

b239019

TomAFrench approved these changes Feb 20, 2025

View reviewed changes

TomAFrench marked this pull request as ready for review February 20, 2025 18:14

TomAFrench added this pull request to the merge queue Feb 20, 2025

Merged via the queue into master with commit 757e3c4 Feb 20, 2025
102 checks passed

TomAFrench deleted the mv/profiler-docs branch February 20, 2025 18:27

This was referenced Feb 20, 2025

chore(ci): Missing dash in profiler command argument #7467

Merged

Document execution-opcodes command in noir-profiler. #7471

Closed

AztecBot mentioned this pull request Feb 20, 2025

feat: Sync from noir AztecProtocol/aztec-packages#12129

Closed

AztecBot mentioned this pull request Feb 20, 2025

feat: Sync from noir AztecProtocol/aztec-packages#12176

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(docs): Noir Profiler external documentation #7457

chore(docs): Noir Profiler external documentation #7457

vezenovm commented Feb 20, 2025 •

edited by Savio-Sou

Loading

github-actions bot left a comment

github-actions bot commented Feb 20, 2025 •

edited

Loading

github-actions bot commented Feb 20, 2025

TomAFrench commented Feb 20, 2025

chore(docs): Noir Profiler external documentation #7457

chore(docs): Noir Profiler external documentation #7457

Conversation

vezenovm commented Feb 20, 2025 • edited by Savio-Sou Loading

Description

Problem*

Summary*

Additional Context

Documentation*

PR Checklist*

github-actions bot left a comment

Choose a reason for hiding this comment

⚠️ Performance Alert ⚠️

github-actions bot commented Feb 20, 2025 • edited Loading

github-actions bot commented Feb 20, 2025

TomAFrench commented Feb 20, 2025

vezenovm commented Feb 20, 2025 •

edited by Savio-Sou

Loading

github-actions bot commented Feb 20, 2025 •

edited

Loading