Skip to content

Commit 81e3b9b

Browse files
authored
[mlir][doc] remove trailing whitespace from MD files (#168)
Also add "sparsifier" for "sparse compiler" and changes layout in open projects to make it more clear where new projects begin
1 parent 31c474a commit 81e3b9b

File tree

7 files changed

+14
-20
lines changed

7 files changed

+14
-20
lines changed

website/content/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To be notified of the next meeting, please subscribe to the
2020
category on Discourse.
2121

2222
You can register to [this public calendar](https://calendar.google.com/calendar/u/0?cid=N2EzMDU3NTBjMjkzYWU5MTY5NGNlMmQ3YjJlN2JjNWEyYjViNjg1NTRmODcxOWZiOTU1MmIzNGQxYjkwNGJkZEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t)
23-
to keep up-to-date with the schedule.
23+
to keep up-to-date with the schedule.
2424

2525
If you’d like to discuss a particular topic or have questions, please add it to the
2626
[agenda doc](https://docs.google.com/document/d/1y2YlcOVMPocQjSFi3X6gYGRjA0onyqr41ilXji10phw/edit#).

website/content/deprecation/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ The passes `gpu-to-(cubin|hsaco)` will be removed in a future release.
7979

8080
### Port uses of LLVM Dialect to opaque pointers
8181

82-
LLVM 17 has stopped officially supporting typed pointers, and MLIRs LLVM Dialect
82+
LLVM 17 has stopped officially supporting typed pointers, and MLIRs LLVM Dialect
8383
is now in the process of dropping the support as well. This was announced back
8484
in February 2023 ([PSA](https://discourse.llvm.org/t/psa-in-tree-conversion-passes-can-now-be-used-with-llvm-opaque-pointers-please-switch-your-downstream-projects/68738))
8585
, and now the final steps, i.e., removing the typed pointers, have started

website/content/getting_started/Faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Please do **not** cite the arXiv preprint as it is not a formal peer-reviewed
4141
publication.
4242

4343
## Why is \<small feature\> not available in MLIR?
44-
44+
4545
On general basis, there is never a reason why a small feature is not available in MLIR other than nobody needed it enough to implement it. Consider submitting a patch. For larger features and dialects, follow the [request-for-comments](https://mlir.llvm.org/getting_started/DeveloperGuide/#guidelines-on-contributing-a-new-dialect-or-important-components) process.
4646

4747
## MLIR is too heavy framework, should I just reimplement my own compiler from scratch?

website/content/getting_started/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ cmake -G Ninja ../llvm \
4949
# CCache can drastically speed up further rebuilds, try adding:
5050
# -DLLVM_CCACHE_BUILD=ON
5151
# Optionally, using ASAN/UBSAN can find bugs early in development, enable with:
52-
# -DLLVM_USE_SANITIZER="Address;Undefined"
52+
# -DLLVM_USE_SANITIZER="Address;Undefined"
5353
# Optionally, enabling integration tests as well
5454
# -DMLIR_INCLUDE_INTEGRATION_TESTS=ON
5555
cmake --build . --target check-mlir

website/content/getting_started/openprojects.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,8 @@ starting on these projects.
2929
* TableGen "front-end dialect" (mentor: Jacques Pienaar)
3030
* Making MLIR interact with existing polyhedral tools: isl, pluto (mentor: Alex Zinenko)
3131
* MLIR visualization (mentor: Jacques Pienaar)
32-
* MLIR sparse compiler [starter tasks](https://github.com/llvm/llvm-project/labels/mlir%3Asparse) (mentor: Aart Bik)
33-
34-
MLIR allows for representing multiple levels of abstraction all together in the same IR/function. Visualizing MLIR modules therefore requires going beyond visualizing a graph of nodes all at the same level (which is not trivial in and of itself!), nor is it specific to Machine Learning. Beyond visualizing a MLIR module, there is also visualizing MLIR itself that is of interest. In particular, visualizing the rewrite rules, visualizing the matching process (including the failure to match, sort of like https://www.debuggex.com/ but for declarative rewrites), considering effects of rewrites over time, etc.
35-
36-
The visualizations should all be built with open source components but whether standalone (e.g., combining with, say, GraphViz to generate offline images) or dynamic tools (e.g., displayed in browser) is open for discussion. It should be usable completely offline in either case.
37-
38-
We will be working with interested students to refine the exact project based on interests given the wide scope of potential approaches. And open to proposals within this general area.
39-
32+
* MLIR sparsifier (aka sparse compiler) [starter tasks](https://github.com/llvm/llvm-project/labels/mlir%3Asparse) (mentor: Aart Bik)
33+
* MLIR allows for representing multiple levels of abstraction all together in the same IR/function. Visualizing MLIR modules therefore requires going beyond visualizing a graph of nodes all at the same level (which is not trivial in and of itself!), nor is it specific to Machine Learning. Beyond visualizing a MLIR module, there is also visualizing MLIR itself that is of interest. In particular, visualizing the rewrite rules, visualizing the matching process (including the failure to match, sort of like https://www.debuggex.com/ but for declarative rewrites), considering effects of rewrites over time, etc. The visualizations should all be built with open source components but whether standalone (e.g., combining with, say, GraphViz to generate offline images) or dynamic tools (e.g., displayed in browser) is open for discussion. It should be usable completely offline in either case. We will be working with interested students to refine the exact project based on interests given the wide scope of potential approaches. And open to proposals within this general area.
4034
* Rewrite patterns expressed in MLIR (mentor: Jacques Pienaar)
4135
* Generic value range analysis for MLIR (mentor: River Riddle)
4236

@@ -45,12 +39,12 @@ starting on these projects.
4539
This is section for projects that have not yet started but there are
4640
individuals/groups intending to start work on in near future.
4741

48-
* Rework the MLIR python bindings, add a C APIs for core concepts (mentor:
42+
* Rework the MLIR python bindings, add a C APIs for core concepts (mentor:
4943
Nicolas Vasilache, Alex Zinenko)
5044
* [bugpoint/llvm-reduce](https://llvm.org/docs/BugpointRedesign.html) kind
5145
of tools for MLIR (mentor: Mehdi Amini, Jacques Pienaar)
5246
* MLIR visualization, there are some projects in flight but we unfortunately
5347
don't know the project plans of those teams. But if you intend to work on
54-
something in this area it would be good to discuss on the forum early
55-
in case there are collaboration opportunity.
56-
48+
something in this area it would be good to discuss on the forum early
49+
in case there are collaboration opportunity.
50+

website/content/talks/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ to discuss a particular topic or have questions, please add it to the
7878

7979
The meetings are announced on [Discourse](https://discourse.llvm.org/c/mlir/mlir-announcements/44),
8080
subscribing to this category is the best way to stay informed. You can also register
81-
to [this public calendar](https://calendar.google.com/calendar/u/0?cid=N2EzMDU3NTBjMjkzYWU5MTY5NGNlMmQ3YjJlN2JjNWEyYjViNjg1NTRmODcxOWZiOTU1MmIzNGQxYjkwNGJkZEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t).
81+
to [this public calendar](https://calendar.google.com/calendar/u/0?cid=N2EzMDU3NTBjMjkzYWU5MTY5NGNlMmQ3YjJlN2JjNWEyYjViNjg1NTRmODcxOWZiOTU1MmIzNGQxYjkwNGJkZEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t).
8282

8383

8484
### About MLIR and MLIR Components

website/content/users/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ Beaver provides a simple, intuitive, and extensible interface for MLIR.
2323
## [Bᴛᴏʀ2ᴍʟɪʀ](https://github.com/jetafese/btor2mlir): A Format and Toolchain for Hardware Verification
2424

2525
Bᴛᴏʀ2ᴍʟɪʀ applies MLIR to the domain of hardware verification by offering a clean way to take advantage of a format's
26-
strengths. For example, we support the use of software verification methods for hardware
27-
verification problems represented in the Bᴛᴏʀ2 format. The project aims to spur and support research
28-
in the formal verification domain, and has been shown to be competitive with existing methods.
26+
strengths. For example, we support the use of software verification methods for hardware
27+
verification problems represented in the Bᴛᴏʀ2 format. The project aims to spur and support research
28+
in the formal verification domain, and has been shown to be competitive with existing methods.
2929

3030
## [Catalyst](https://github.com/PennyLaneAI/catalyst)
3131

0 commit comments

Comments
 (0)