search

executablebooks / sphinx-proof

A Sphinx extension for producing proof, theorem, lemma, definition, remark, conjecture, corollary and algorithm directives.
https://sphinx-proof.readthedocs.io/en/latest/
MIT License
30 stars 16 forks source link

Please add an "assumption" directive. #73

Open shailesh1729 opened 2 years ago

shailesh1729 commented 2 years ago

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

welcome[bot] commented 2 years ago

Thanks for opening your first issue here! Engagement like this is essential for open source projects! :hugs:
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! :tada:

ghost commented 2 years ago

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

shailesh1729 commented 2 years ago

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 commented 2 years ago

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