Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add FM project #211

Merged
merged 3 commits into from
Jun 20, 2023
Merged

feat: add FM project #211

merged 3 commits into from
Jun 20, 2023

Conversation

jybai
Copy link
Contributor

@jybai jybai commented Feb 26, 2023

Issue #, if available:

Description of changes:

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@OctoberChang
Copy link
Contributor

@jybai , thanks for creating the pull request.

Here are some suggestions before merge:

  • We need to pin down the dependencies (e.g., libpecos version), as your code depends on the c/c++ libraries in pecos folder.
  • We can not include binary pdf files (i.e., FM_O_dk.pdf). You can write math equations in Github readme markdown, or attach a hyper-link to the pdf stored on other cloud storages.

Let me know if you have time to address it. Otherwise, I will close this pull request.

@jybai
Copy link
Contributor Author

jybai commented Jun 1, 2023

@OctoberChang Thank you for your prompt reply. I think I'd be able to fix it. The pdf part is simple. Regarding the dependency, I'm not sure what exactly should I do. Should I specify which version of pecos is used in the README?

@OctoberChang
Copy link
Contributor

@OctoberChang Thank you for your prompt reply. I think I'd be able to fix it. The pdf part is simple. Regarding the dependency, I'm not sure what exactly should I do. Should I specify which version of pecos is used in the README?

  1. Here are an example you can put into Install Section of the README.md.
# git clone with a specific release tag v0.4.0
git clone -b v0.4.0 https://github.com/amzn/pecos.git;
cd pecos/example/fm;
make all
  1. Another suggestion is the folder name fm could be a bit ambiguous. Can you rename it to more specific one, such as fm-for-xmc ?

@jybai
Copy link
Contributor Author

jybai commented Jun 3, 2023

@OctoberChang I have updated the directory name, README, and FM complexity doc file according to suggestions. Please let me know if anything else needs fixing. Many thanks.

@OctoberChang OctoberChang self-assigned this Jun 20, 2023
@OctoberChang OctoberChang self-requested a review June 20, 2023 17:38
@OctoberChang OctoberChang merged commit 037312f into amzn:mainline Jun 20, 2023
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.

2 participants