rework docs: simpler readme/index, modeling file as goto place #349
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cpmpy/expressions/variables.py
Outdated
| @@ -21,7 +21,7 @@ | |||
| ================== | |||
|
|
|||
| A decision variable is a variable whose value will be determined by the solver. | |||
|
|
|||
| h | |||
cpmpy/model.py
Outdated
| if len(con) == 1: | ||
| con = con[0] | ||
|
|
||
| else: |
There was a problem hiding this comment.
Can also be an elif but this is more readable
docs/modeling.md
Outdated
| ```python | ||
| import cpmpy as cp | ||
| ``` | ||
| which we will use below. |
There was a problem hiding this comment.
which is how we will use it?
docs/modeling.md
Outdated
|
|
||
| `solution_hint()` tells the solver that it could use these variable-values first during search, e.g. typically from a previous solution: | ||
| ```python | ||
| from cpmpy import * |
There was a problem hiding this comment.
use import cpmpy as cp?
docs/modeling.md
Outdated
| You provide it with the name of the function you want to call, as well as the arguments: | ||
|
|
||
| ```python | ||
| from cpmpy import * |
There was a problem hiding this comment.
use import cpmpy as cp?
docs/modeling.md
Outdated
| Note that any argument given will be checked for whether it needs to be mapped to a native solver variable. This may give errors on complex arguments, or be inefficient. You can tell the `DirectConstraint` not to scan for variables with `noarg` argument, for example: | ||
|
|
||
| ```python | ||
| from cpmpy import * |
There was a problem hiding this comment.
use import cpmpy as cp?
docs/modeling.md
Outdated
| The `DirectConstraint("AddAllDifferent", iv)` is equivalent to the following code, which demonstrates that you can mix the use of CPMpy with calling the underlying solver directly: | ||
|
|
||
| ```python | ||
| from cpmpy import * |
There was a problem hiding this comment.
use import cpmpy as cp?
|
@tias yes, this is better to avoid confusion. |
|
pulled out the code changes, all other feedback should be in. I will merge this somewhere tomorrow, can still be improved afterwards |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
merged different versions of 'usage' docs into the file 'modeling'
then reworked it substantially to be more extensive, to be oriented to starting users, and to Python users specifically, so little to no CP knowledge.
It raised a range of other questions/loose ends, some of them indicated in the text (to be removed), some of them half-implemented. All code changes in this PR will be spun out in separate pull requests.
I tried to be succinct yet introduce cases people should know about in
modeling.md. Helene @363734 is this in line with what you were looking for? Anything you feel missing or should be clarified?