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

Please add an "assumption" directive. #73

Open
shailesh1729 opened this issue Dec 30, 2021 · 4 comments
Open

Please add an "assumption" directive. #73

shailesh1729 opened this issue Dec 30, 2021 · 4 comments
Labels
enhancement New feature or request

Comments

@shailesh1729
Copy link
Contributor

Description / Summary

When describing a mathematical algorithm, it is sometimes important to describe a set of assumptions under which the algorithm is expected to perform correctly. For example, the convergence of the projected subgradient algorithm depends on some assumption that the subgradients are bounded. Usually, a theorem would state its assumptions as part of its statement. However, there are times when assumptions are pervading across a large body of text and it's worthwhile to state them and refer to them independently.

The use of "assumption" environment can be seen in books like Beck, Amir. First-order methods in optimization. Society for Industrial and Applied Mathematics, 2017.

Value / benefit

This will help in writing some mathematical text related to the specification and convergence analysis of optimization algorithms.

Implementation details

I guess this should be similar to existing directives like observation and remark. Just a different name (assumption).

Tasks to complete

No response

@shailesh1729 shailesh1729 added the enhancement New feature or request label Dec 30, 2021
@welcome
Copy link

welcome bot commented Dec 30, 2021

Thanks for opening your first issue here! Engagement like this is essential for open source projects! 🤗

If you haven't done so already, check out EBP's Code of Conduct. Also, please try to follow the issue template as it helps other community members to contribute more effectively.

If your issue is a feature request, others may react to it, to raise its prominence (see Feature Voting).

Welcome to the EBP community! 🎉

@ghost
Copy link

ghost commented Jan 15, 2022

I have the same demand. When I write some theoritical statistics proofs, the "assumption"s are the most important block.

@shailesh1729
Copy link
Contributor Author

Hi, I have created a pull request to support assumption directives. If it all looks good, I would request you to kindly merge it. It will help me with my (open source) notes https://convex.indigits.com/intro.html.

@mmcky
Copy link
Member

mmcky commented Jun 27, 2022

thanks @shailesh1729 I will try and take a look soon. Appreciate the Pull Request.

AakashGfude added a commit that referenced this issue Jul 14, 2022
* Support for assumption directive   #73

* pre-commit runs

* translation json for assumption directive

Co-authored-by: AakashGC <aakashguptachoudhury@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants