Small improvements in catalyst cli docs, option help, and intermediate file naming

[mehrdad2m]

Context:
This PR fixes some small bugs or lack of documentation for catalyst-cli gathered from @dime10's feedbacks.

• The --help flag seems to dump a lot of unrelated options which makes it difficult to navigate through catalyst options.

• The possible stages for the --checkpoint-stage option are not mentioned in the documentation

• When using --checkpoint-stage, --save-ir-after-each=pipeline no longer works.

• The output from --save-ir-after-each=pass produces one output for each function when dealing with a function pass which results in a large number of outputs and one has to find the function of interest randomly.

Description of the Change:

• --help option now prints all the catalyst-cli specific options first before jumping into mlir-opt options

• Added more details to documentation

• Fixed the bug for save-ir-after-each and save-ir-after-each coexisting together.

• Output from save-ir-after-each now appends the name of the function to the file name making it easier to identify the desired output.

Benefits:
easier experience for catalyst-cli user

Possible Drawbacks:

Related GitHub Issues:

[dime10]

Nice work, these are great improvements 🚀 🚀

I'm happy to merge as is, although for the help output I still wonder if we couldn't put the mlir-opt output behind an additional option, like --help-passes, --help-opt, --help-tool or something like that. The main --help option can then point out that there are additional help pages. It's just such a slog to scroll through all the output.

[joeycarter]

@mehrdad2m and @dime10, do we want to get this in for the release?

[joeycarter]

Thanks @mehrdad2m! Just had a few editorial suggestions.

[mehrdad2m]

@mehrdad2m and @dime10, do we want to get this in for the release?

Hi @joeycarter Yes I think it should be in the release. On my side it is ready to be merged. I can merged it after addressing your comments

[joeycarter]

Hi @joeycarter Yes I think it should be in the release. On my side it is ready to be merged. I can merged it after addressing your comments

Great, thanks! In that case, can you move the changelog entry to doc/releases/changelog-0.10.0.md?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.91%. Comparing base (4da5563) to head (2cb7817).
Report is 3 commits behind head on v0.10.0-rc.

Additional details and impacted files

@@              Coverage Diff               @@
##           v0.10.0-rc    #1405      +/-   ##
==============================================
+ Coverage       96.68%   96.91%   +0.23%     
==============================================
  Files              75       58      -17     
  Lines            8266     6880    -1386     
  Branches          867      796      -71     
==============================================
- Hits             7992     6668    -1324     
+ Misses            221      159      -62     
  Partials           53       53              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.