-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: improve global structure (#1023)
Closes #1029 ### Summary of Changes * Separate explanation of the pipeline and the stub language. * Explain segments after comments. They are not needed to get started. * Improve home page. * Improve installation guide. * Improve home page of language reference. * Improve documentation of packages.
- Loading branch information
1 parent
8be49c5
commit def5279
Showing
100 changed files
with
936 additions
and
180 deletions.
There are no files selected for viewing
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
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
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# Your First Safe-DS Program | ||
|
||
TODO |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Installation | ||
|
||
To set up a powerful _integrated development environment_ (_IDE_) for Safe-DS, follow these steps: | ||
|
||
1. **Install [Visual Studio Code](https://code.visualstudio.com/)** (VS Code). | ||
2. **Install the [Safe-DS extension](https://marketplace.visualstudio.com/items?itemName=safe-ds.safe-ds)** for VS Code. | ||
|
||
To run Safe-DS programs, you also need the [Safe-DS Runner](https://github.com/Safe-DS/Runner): | ||
|
||
1. **Install [Python](https://www.python.org/) (3.11 or 3.12)**. Make sure to add Python to your | ||
system's `PATH` during installation. Verify installation by running `python --version` in a | ||
command line. You should get output similar to `Python 3.12.2`. | ||
2. **Open VS Code**. | ||
3. **Open the command palette** (Menu bar > View > Command Palette). | ||
4. **Type `Install the Safe-DS Runner`**. | ||
5. **Press ++enter++**. Installation may take a few minutes, since it downloads and installs several large libraries | ||
like PyTorch. | ||
|
||
## Updating the Safe-DS Extension | ||
|
||
By default, VS Code automatically updates extensions. You only need to restart VS Code to apply the update. | ||
|
||
## Updating the Safe-DS Runner | ||
|
||
You need to update the Safe-DS Runner if you see an error message like this: | ||
|
||
!!! failure "Error message" | ||
|
||
The installed runner version `0.9.0` is not compatible with this version of the extension. | ||
|
||
The installed version should match these requirements: `>=0.10.0,<0.11.0`. Please update to a matching version. | ||
|
||
Click on the button "Update runner" in the error message to trigger the update process. |
File renamed without changes
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +0,0 @@ | ||
# Safe-DS DSL Tutorial | ||
|
||
The Safe-DS DSL is split into two main parts: | ||
|
||
- The _[pipeline language][pipeline-language]_ is used to solve specific data science problems. Unless you want to add functionality to Safe-DS, this sublanguage is all you need to learn. To use the pipeline language, create a file with the extension `.sds`. | ||
- The _[stub language][stub-language]_ is used to integrate external code written in Python into Safe-DS, so it can be used in the [pipeline language][pipeline-language]. The main purpose of this sublanguage is to define the [Safe-DS Standard Library (stdlib)][stdlib]. To use the stub language, create a file with the extension `.sdsstub`. | ||
|
||
[pipeline-language]: pipeline-language/README.md | ||
[stub-language]: stub-language/README.md | ||
[stdlib]: https://github.com/Safe-DS/DSL/blob/main/packages/safe-ds-lang/src/resources/builtins | ||
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +0,0 @@ | ||
# Pipeline Language | ||
|
||
The pipeline language is the part of the Safe-DS DSL that is designed to solve specific data science problems. It has the following concepts: | ||
|
||
- [Packages][packages] help avoid conflicts that could arise if two declarations have the same name. | ||
- [Imports][imports] make declarations in other packages accessible. | ||
- [Pipelines][pipelines] define the entry point of a data science program. | ||
- [Segments][segments] encapsulate parts of a data science program and make them reusable. | ||
- [Statements][statements] are the instructions that are executed as part of a [pipeline][pipelines], [segment][segments], or [block lambda][block-lambdas]. | ||
- [Expressions][expressions] are computations that produce some value. | ||
- [Comments][comments] document the code. | ||
|
||
Files that use the pipeline language must have the extension `.sds`. | ||
|
||
[packages]: ../common/packages.md | ||
[imports]: ../common/imports.md | ||
[pipelines]: pipelines.md | ||
[segments]: segments.md | ||
[statements]: statements.md | ||
[expressions]: expressions.md | ||
[block-lambdas]: expressions.md#block-lambdas | ||
[comments]: ../common/comments.md | ||
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Language Reference | ||
|
||
Safe-DS is a domain-specific language (DSL) to quickly and safely develop data science programs. In this context, | ||
safety means that it tries to prevent errors or detect them while you program, so you do not waste time running a | ||
program that will fail. | ||
|
||
!!! note "File extension" | ||
|
||
Safe-DS programs must have the file extension `sds`, like in `titanic.sds`. | ||
|
||
This remaining documentation provides a detailed reference for the concepts of the Safe-DS language: | ||
|
||
- [Packages][packages] help avoid conflicts that could arise if two declarations have the same name. | ||
- [Pipelines][pipelines] define the entry point of a program. | ||
- [Statements][statements] are the instructions that are executed as part of a program. | ||
- [Expressions][expressions] are computations that produce some value. | ||
- [Comments][comments] document the code. | ||
- [Segments][segments] encapsulate parts of program and make them reusable. | ||
- [Types][types] describe the kind of data that a declaration accepts. | ||
- [Imports][imports] make declarations in other packages accessible. | ||
|
||
|
||
[packages]: packages.md | ||
[pipelines]: pipelines.md | ||
[statements]: statements.md | ||
[expressions]: expressions.md | ||
[comments]: comments.md | ||
[segments]: segments.md | ||
[types]: types.md | ||
[imports]: imports.md |
Oops, something went wrong.