Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.14
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,16 @@ documentation versions.

## Compiling the manual

Create a venv and `pip install -r requirements.txt`.
Use uv for installing dependencies:

```sh
uv sync
```

To launch the devserver and see changes live:

```sh
mkdocs serve
uv run mkdocs serve
```

## Publishing
Expand Down
15 changes: 12 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,24 @@ Support for more GPU vendors and CUDA APIs is in development.
## How do I use SCALE?

1. [Install SCALE](./manual/how-to-install.md).
2. Activate SCALE, eg. `. /opt/SCALE/scaleenv gfx1100`
3. Compile your application, following the same steps you would use for
1. Activate SCALE, eg. `. /opt/SCALE/scaleenv gfx1100`
We validate SCALE by compiling open-source CUDA projects and running their
1. Compile your [CUDA code with SCALE](https://docs.scale-lang.com/stable/manual/how-to-use/), following steps similar to
NVIDIA CUDA.

## What projects have been tested?

We validate SCALE by compiling open-source CUDA projects and running their
tests. The list of currently-tested projects and their compatibility status
can be found [here](https://github.com/spectral-compute/scale-validation?tab=readme-ov-file#current-status)
can be found [here](https://github.com/spectral-compute/scale-validation?tab=readme-ov-file#current-status).

Join our [Discord](https://discord.com/invite/KNpgGbTc38) to let us know what projects are missing (_or_ support our mission by contributing yourself).

## What are examples of using SCALE?

Our [SCALE Examples](https://docs.scale-lang.com/stable/examples/) section show very basic examples of using SCALE and are a great place to start your hands-on experience.

We welcome contributions from our developer community. Join our [Discord](https://discord.com/invite/KNpgGbTc38) to share _your_ SCALE projects.

## Which GPUs are supported?

Expand Down
15 changes: 15 additions & 0 deletions docs/contact/join-our-discord.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Join our Discord

The success of SCALE very much depends on the developer community supporting it. We invite anyone curious about our technology to join our [Discord server](https://discord.gg/KNpgGbTc38) and follow our journey.

On our [Discord](https://discord.gg/KNpgGbTc38), we aim to:

- Inform about [upcoming SCALE releases](https://docs.scale-lang.com/stable/manual/CHANGELOG/)
- Share latest our [SCALE blog posts](https://scale-lang.com/posts)
- Deep dive on technical questions (nerd out)
- Discuss HPC industry trends
- Gather feedback for **our amazing community**!




39 changes: 29 additions & 10 deletions docs/manual/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,47 @@

## How do I report a problem?

[Contact us](../contact/report-a-bug.md)
Go ahead and [contact us](../contact/report-a-bug.md) if facing problems.

Bug reports - no matter how small - accelerate the SCALE project.

Let's work together to democratise the GPGPU market!
Let's work together to democratise the GPU market!

## Is SCALE free?
SCALE is free for non-commercial use including research and academia.

For commercial use, a license agreement is required.

To learn more about licencing SCALE, we invite you to [read this](https://scale-lang.com/#licensing) or [contact us](../contact/report-a-bug.md).

## Does SCALE increase performance?
In many cases, yes, it does.

Seeking to 'reduce compute cost' and/or 'increase performance' are good reasons to explore SCALE. That said, these depend on the specific compute workload in question and benchmarks will be different from one CUDA project to the other.

For the latest performance benchmarks, see [this section](https://scale-lang.com/#benchmarks) of our website.

## When will `<some GPU>` be supported?

Expanding the set of supported GPUs is an ongoing process. We already
support some GPUs ROCM has dropped support for (eg. gfx900), and are
working to expand the set further. If there's a device you want to bring
to our attention, please get in touch.
support some GPUs that vendors has dropped support for (eg. AMD MI25 / gfx900), and are
working to expand the set further. If there's a GPU you want to bring
to our attention, please [get in touch](../contact/report-a-bug.md).

## When will `<some CUDA API>` be supported?

We prioritise CUDA APIs based on the number and popularity of third-party
We prioritise CUDA APIs based on the number (and popularity) of third-party
projects requiring the missing API.

If you'd like to bring a missing API to our attention,
[Contact us](../contact/report-a-bug.md)
[contact us](../contact/report-a-bug.md).

## Does SCALE infringe NVIDIA’s copyright?
By design, SCALE does _not_ infringe NVIDIA’s EULAs or copyright.

We think CUDA is **amazing** and we follow the guidelines set by NVIDIA.

Check out [this post](https://www.linkedin.com/posts/spectral-compute_write-cuda-run-everywhere-activity-7399130853668245504-dvWQ) for an elaborate explanation.

## Can't NVIDIA just change CUDA and break SCALE?

Expand Down Expand Up @@ -80,6 +101,4 @@ compiler research problem, but it is possible.

## Does it work on Windows?

Not yet. :(

Windows support is a challenge that we have ideas about.
Not yet, but windows support is a challenge that we have ideas about.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@ nav:
- manual/api-runtime.md
- Contact Us:
- contact/report-a-bug.md
- contact/join-our-discord.md
- Legal:
- licensing.md
- notices.md
Expand Down
39 changes: 39 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
[project]
name = "scale-docs"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.14"
dependencies = [
"babel==2.15.0",
"certifi==2024.7.4",
"charset-normalizer==3.3.2",
"click==8.1.7",
"colorama==0.4.6",
"ghp-import==2.1.0",
"idna==3.7",
"jinja2==3.1.4",
"markdown==3.6",
"markupsafe==2.1.5",
"mergedeep==1.3.4",
"mike==2.1.3",
"mkdocs==1.6.0",
"mkdocs-get-deps==0.2.0",
"mkdocs-macros-plugin==1.3.7",
"mkdocs-material==9.6.9",
"mkdocs-material-extensions==1.3.1",
"packaging==24.1",
"paginate==0.5.6",
"pathspec==0.12.1",
"platformdirs==4.2.2",
"pygments==2.18.0",
"pymdown-extensions==10.8.1",
"python-dateutil==2.9.0.post0",
"pyyaml==6.0.1",
"pyyaml-env-tag==0.1",
"regex==2024.5.15",
"requests==2.32.3",
"six==1.16.0",
"urllib3==2.2.2",
"watchdog==4.0.1",
]
Loading