Skip to content

docs: fix broken markdown #549

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: fix broken markdown #549

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d39926c
docs: fix broken markdown
mostlyken Aug 15, 2025
4160027
Merge branch 'main' into FIX_docker_instructions
mostlyken Sep 1, 2025
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
22 changes: 13 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,35 +243,39 @@ As an alternative, you can also build a Docker image, which provides you with an

<summary>Get the image</summary>

- **Pull from official repository**
<ul>
<li><strong>Pull from official repository</strong></li>
</ul>

`docker pull --platform=linux/amd64 ghcr.io/mostly-ai/sdk`
<code>docker pull --platform=linux/amd64 ghcr.io/mostly-ai/sdk</code>

- **(Optional) Build your own image**
<ul>
<li><strong>Pull from official repository</strong></li>
</ul>

If your environment is capable of executing Makefile (see [here](https://github.com/mostly-ai/mostlyai/blob/main/Makefile#L47-L73)), then execute `make docker-build`.
If your environment is capable of executing Makefile (see <a href="https://github.com/mostly-ai/mostlyai/blob/main/Makefile#L47-L73">here</a>), then execute <code>make docker-build</code>.

Otherwise, use `docker buildx build . --platform=linux/amd64 -t ghcr.io/mostly-ai/sdk` instead.
Otherwise, use <code>docker buildx build . --platform=linux/amd64 -t ghcr.io/mostly-ai/sdk</code> instead.

</details>

<details>

<summary>Start the container</summary>

This will launch the SDK in LOCAL mode on port 8080 inside the container.
<p>This will launch the SDK in LOCAL mode on port 8080 inside the container.</p>

If your environment is capable of executing Makefile, then execute `make docker-run`. Or `make docker-run HOST_PORT=8080` to forward to a host port of your choice. One could also mount the `local_dir` via `make docker-run HOST_LOCAL_DIR=/path/to/host/folder` to make the generators and synthetic datasets directly accessible from the host.
<p>If your environment is capable of executing Makefile, then execute <code>make docker-run</code>. Or <code>make docker-run HOST_PORT=8080</code> to forward to a host port of your choice. One could also mount the <code>local_dir</code> via <code>make docker-run HOST_LOCAL_DIR=/path/to/host/folder</code> to make the generators and synthetic datasets directly accessible from the host.</p>

Otherwise, use `docker run --platform=linux/amd64 -p 8080:8080 ghcr.io/mostly-ai/sdk` instead. Optionally, you can use the `-v` flag to mount a [volume](https://docs.docker.com/engine/storage/volumes/#syntax) for passing files between the host and the container.
<p>Otherwise, use <code>docker run --platform=linux/amd64 -p 8080:8080 ghcr.io/mostly-ai/sdk</code> instead. Optionally, you can use the <code>-v</code> flag to mount a <a href="https://docs.docker.com/engine/storage/volumes/#syntax">volume</a> for passing files between the host and the container.</p>

</details>

<details>

<summary>Connect to the container</summary>

You can now connect to the SDK running within the container by initializing the SDK in `CLIENT` mode on the host machine.
<p>You can now connect to the SDK running within the container by initializing the SDK in <code>CLIENT</code>> mode on the host machine.</p>

```python
from mostlyai.sdk import MostlyAI
Expand Down
Loading