llvm/mlir-www

MLIR WWW

This contains the source code for https://mlir.llvm.org/ ; which is rendered from the gh-pages branch of the same repo using GitHub pages.

To contribute, feel free to fork this repository and send a pull-request.

The website is deployed on every push to this repository using a GitHub action defined in .github/workflows/main.yml. It also runs every 4 hours to catch updates from the MLIR source repository (the LLVM monorepo), which is used for generating some docs.

We are using the Hugo framework for generating the website. The source pages are written in Markdown format under the website/content folder.

A large part of the documentation is auto-generated from the MLIR source code. See the workflow .github/workflows/main.yml for the instructions to reproduce the entirety of https://mlir.llvm.org/ locally.

After running the code from the workflow, download hugo on your machine, and run hugo server from the website directory. You can then access a local version of the website from http://localhost:1313/; any change you make to the source Markdown will automatically be refreshed by the local hugo server.

When making changes it is often not useful to check out the doxygen branch so consider checking out only the main branch. For example, if using gh, only the following is needed

gh repo clone llvm/mlir-www -- --single-branch --branch main

mlir-www's Issues

[Tracking] Glossary Words Thread

Please edit this comment to put in requests for terms to be explained in the MLIR glossary at https://mlir.llvm.org/getting_started/Glossary/

(source: : https://github.com/llvm/mlir-www/blob/main/website/content/getting_started/Glossary.md )

• ValueSemantics
• Materialize
• Ways of writing passes: DialectConversionFramework, greedy patterns, and canonicalization
• CSE (common subexpression elimination) #185
• DCE (dead code elimination) #185
• constEval
• Signedness (would love to know where in the pipeline do we stop dealing with signedness)

Add Python doc generation to MLIR Website

Currently only c++/doxygen code generation is performed when generating the website.

Generated heading for pass descriptions

These seem missing

C4ML/CGO 2020

Any MLIR pdf/slides from the event?

Update to address issues flagged by dependabot

image file is not shown at https://mlir.llvm.org/docs

We cannot see an image (near the words "Index Map Example") at https://mlir.llvm.org/docs/LangRef/ while it is referred to as ![Index Map Example](includes/img/index-map.svg) in https://github.com/llvm/llvm-project/blob/master/mlir/docs/LangRef.md.

As far as I know, the files under mlir/docs/includes are not copied in these files.
https://github.com/llvm/mlir-www/blob/master/copy_docs.sh
https://github.com/llvm/mlir-www/blob/master/.github/workflows/main.yml

Support for ebook generation

It would be nice if people could read MLIR docs on Kindles and other e-readers.

Reminder for EuroLLVM 2020

This is just a reminder to add slides refernce from EuroLLVM cause it is full of (Google members) MLIR talks 😉 http://llvm.org/devmtg/2020-04/talks.html

Survey paper

Do you think It could be interesting to add this survey somewhere?https://arxiv.org/abs/2002.03794

Dialects section bug for alignment of "PDLExtensionOps" on mlir page.

Attaching image of the issue I stumbled upon luckily when my mouse pointer was idle,
There seems to be a hidden link for "PDLExtensionOps" before the "acc" Dialect.
When right clicked it opens this page - > https://mlir.llvm.org/docs/Dialects/PDLExtensionOps/

Undocumented LLVM_TARGETS_TO_BUILD values "Native" and "host" used and used inconsistently

https://mlir.llvm.org/getting_started/ says (under "Unix-like compile/testing"):

cmake ... -DLLVM_TARGETS_TO_BUILD="Native;NVPTX;AMDGPU" ...

whereas, under "Windows compile/testing" it says:

cmake ... -DLLVM_TARGETS_TO_BUILD="host" ...

However, neither "Native" nor "host" are documented as valid values for LLVM_TARGETS_TO_BUILD (the only symbolic value listed is "all").

This is inconsistent and in a "Getting Started" document it is also unfortunate that an undocumented flag value is used.

A quick grep shows that both "Native" and "host" are used in the sources, even in the same sub-projects. E.g. llvm-project/mlir/examples/standalone/README.md ("host"), llvm-project/mlir/examples/minimal-opt/README.md ("Native"). llvm-project/libcxx/utils/ci/run-buildbot ("host"), and so on.

website build failure after D98041

see error - https://github.com/llvm/mlir-www/runs/2112601922?check_suite_focus=true#step:11:8