Skip to content

Docs default values #132

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Oct 5, 2023
Merged

Docs default values #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b83e1da
fix space default
ImogenBits Oct 5, 2023
77a4861
fix indentation
ImogenBits Oct 5, 2023
24f11a3
fix links
ImogenBits Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions docs/advanced/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ big and offer a lot of room for customization. It's made up of several tables at
`space`
: Limits the amount of memory space the program has available during execution. Can either be an integer which
is interpreted as bytes, a string with a unit such as `500 MB` or `1.3gb`, or `#!toml false` to set no limit.
Defaults to no limit. The
Defaults to 4 GB. The
[Pydantic ByteSize docs](https://docs.pydantic.dev/latest/usage/types/bytesize/#using-bytesize) contain a full
explanation of possible formats.

Expand Down Expand Up @@ -138,8 +138,7 @@ structure with both keys being mandatory:
best fit their development workflow regardless of which ones might be used in the server matches.

`points`
: An integer specifying the maximum number of points a team can achieve during this match. How points are calculated
is explained in more detail [here](match.md#points-calculation). Defaults to 100.
: An integer specifying the maximum number of points a team can achieve during this match. Defaults to 100.

`parallel_battles`
: To speed up battle execution you can let Algobattle run multiple battles in parallel. Note that while programs can
Expand All @@ -154,10 +153,10 @@ structure with both keys being mandatory:
the formatting is very important here, you can not mix the two styles, add any spaces, or similar. A full format
spec can be found on the [Docker site](https://docs.docker.com/config/containers/resource_constraints/).

This option accepts either a single such string, or a list of them. If a list is provided each battle that is run
in parallel will use one of the provided set of cores. For example, if this option is `["0,1", "2-3", "4,5"]` and
there are two battles executed at the same time, the first would use the first two physical CPUs and the second the
next two. Defaults to no CPU limitation.
This option accepts either a single such string, or a list of them. If a list is provided each battle that is
run in parallel will use one of the provided set of cores. For example, if this option is `["0,1", "2-3", "4,5"]`
and there are two battles executed at the same time, the first would use the first two physical CPUs and the
second the next two. Defaults to no CPU limitation.

`name_images`
: Whether to give the Docker images descriptive names. This is very useful during development, but can lead to
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/programs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ The important file here is `generator.py`, we need to put the code that we want
??? question "What's `Dockerfile`?"
This is the file that specified what Docker is supposed to do with our code. What exactly Docker does and what the
Dockerfile says is rather complicated and not super important for us right now. It's explained in detail in the
[docker advanced guide](/advanced/docker.md).
[Docker guide](../advanced/docker.md).

### What it needs to do

Expand Down