-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
### Summary of Changes * Separate README for GitHub * Remove recursive link to full documentation from README of full documentation * Hide navigation of home page to emphasize the navigation bar at the top * Some other tweaks to the navigation settings
- Loading branch information
1 parent
3cb74a2
commit 1ed2d56
Showing
5 changed files
with
71 additions
and
13 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Safe-DS Python Library | ||
|
||
[![PyPI](https://img.shields.io/pypi/v/safe-ds)](https://pypi.org/project/safe-ds) | ||
[![Main](https://github.com/Safe-DS/Library/actions/workflows/main.yml/badge.svg)](https://github.com/Safe-DS/Library/actions/workflows/main.yml) | ||
[![codecov](https://codecov.io/gh/Safe-DS/Library/branch/main/graph/badge.svg?token=HVRP1633B1)](https://codecov.io/gh/Safe-DS/Library) | ||
[![Documentation Status](https://readthedocs.org/projects/safe-ds-stdlib/badge/?version=stable)](https://library.safeds.com) | ||
|
||
A user-friendly library for Data Science (DS) in Python. | ||
|
||
Our goal is to make DS more accessible to a wider audience by providing a simple, intuitive, and consistent API to solve | ||
common tasks on small to moderately sized datasets. As such, a major focus is to provide a learning tool for DS novices. | ||
|
||
Instead of implementing DS methods from scratch, we use established DS libraries under the hood such as: | ||
|
||
* [pandas](https://pandas.pydata.org) for manipulation of tabular data, | ||
* [scikit-learn](https://scikit-learn.org) for machine learning, and | ||
* [seaborn](https://seaborn.pydata.org) for visualization. | ||
|
||
For more specialized tasks, we recommend using these or other DS libraries directly. | ||
|
||
Note that this library is still in development and not yet ready for production. Expect breaking changes in the future | ||
without a major version bump (while in the `0.y.z` version range). Feedback is very welcome, however! If you have a | ||
suggestion or find a bug, please [open an issue](https://github.com/Safe-DS/Library/issues/new/choose). If you have a | ||
question, please [use our discussion forum][forum]. | ||
|
||
## Installation | ||
|
||
Get the latest version from [PyPI](https://pypi.org/project/safe-ds): | ||
|
||
```shell | ||
pip install safe-ds | ||
``` | ||
|
||
## Documentation | ||
|
||
You can find the full documentation [here](https://library.safeds.com). | ||
|
||
## Contributing | ||
|
||
We welcome contributions from everyone. As a starting point, check the following resources: | ||
|
||
* [Setting up a development environment](https://library.safeds.com/en/latest/development/environment/) | ||
* [Project guidelines](https://library.safeds.com/en/latest/development/project_guidelines/) | ||
* [Contributing page](https://github.com/Safe-DS/Library/contribute) | ||
|
||
If you need further help, please [use our discussion forum][forum]. | ||
|
||
[forum]: https://github.com/orgs/Safe-DS/discussions |
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 |
---|---|---|
@@ -1,3 +1,8 @@ | ||
--- | ||
hide: | ||
- navigation | ||
--- | ||
|
||
# Glossary | ||
|
||
## Accuracy | ||
|
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 |
---|---|---|
|
@@ -4,7 +4,7 @@ version = "0.20.0" | |
description = "A user-friendly library for Data Science in Python." | ||
authors = ["Lars Reimann <[email protected]>"] | ||
license = "MIT" | ||
readme = "docs/README.md" | ||
readme = ".github/README.md" | ||
repository = "https://github.com/Safe-DS/Library" | ||
documentation = "https://library.safeds.com" | ||
keywords = ["data-science", "machine-learning", "usability", "learnability"] | ||
|