Skip to content

[circle-mlir] Revise README with how-to build#14843

Merged
seanshpark merged 1 commit intoSamsung:masterfrom
seanshpark:cm_readme_bld
Mar 13, 2025
Merged

[circle-mlir] Revise README with how-to build#14843
seanshpark merged 1 commit intoSamsung:masterfrom
seanshpark:cm_readme_bld

Conversation

@seanshpark
Copy link
Copy Markdown
Contributor

This will revise README file with how-to build the project.

This will revise README file with how-to build the project.

ONE-DCO-1.0-Signed-off-by: SaeHie Park <saehie.park@gmail.com>
@seanshpark
Copy link
Copy Markdown
Contributor Author

@seanshpark seanshpark requested a review from a team March 13, 2025 04:39
Copy link
Copy Markdown
Collaborator

@mhs4670go mhs4670go left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Contributor

@shs-park shs-park left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have suggested some refinements to make the sentence sound a little bit natural.
Applying them is optional, so please take them as a reference.

LGTM!
=)

Comment thread circle-mlir/README.md

Circle MLIR dialect and tools

## Tools provided
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Tools provided
## Provided Tools

Comment thread circle-mlir/README.md
## Tools provided

_onnx2circle_
- conversion tool of ONNX to Circle model for `compiler`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- conversion tool of ONNX to Circle model for `compiler`
- a tool that converts ONNX models to Circle format, used by `compiler`.

Comment thread circle-mlir/README.md
- download and install latest `ONE Release` from https://github.com/Samsung/ONE/releases
- actually we only need `circle-interperter` tool for validation, but not ready yet

Or use local build/install version of `ONE/compiler` and set environment variable;
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Or use local build/install version of `ONE/compiler` and set environment variable;
Alternatively, if you have a locally built version of `ONE/compiler`, set the environment variable as follows;

Comment thread circle-mlir/README.md
make prep
```

NOTE `llvm-project` is built as `Debug` which may require 32G or more RAM.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
NOTE `llvm-project` is built as `Debug` which may require 32G or more RAM.
NOTE `llvm-project` builds in `Debug` mode, which may require 32GB or more RAM.

Comment thread circle-mlir/README.md
Comment on lines +55 to +56
- if build fails for some reason, please change to `-DCMAKE_BUILD_TYPE=Release`
`prep` target in `Makefile.sample` file.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- if build fails for some reason, please change to `-DCMAKE_BUILD_TYPE=Release`
`prep` target in `Makefile.sample` file.
- if the build fails, try changing the build type to `-DCMAKE_BUILD_TYPE=Release`
in the `prep` target of `Makefile.sample` file.

@seanshpark
Copy link
Copy Markdown
Contributor Author

@shs-park , thanks for the suggestion!
Can you post a update as new PR? I think your suggestion is better :)

@seanshpark seanshpark merged commit 91d07d8 into Samsung:master Mar 13, 2025
5 checks passed
@shs-park
Copy link
Copy Markdown
Contributor

Can you post a update as new PR?

Sure, no problem!
=)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants