added german versions

This commit is contained in:
weygoldt
2024-10-18 15:21:58 +02:00
parent 602d9bb422
commit 4696fdc701
5 changed files with 553 additions and 2 deletions

View File

@@ -1,3 +1,28 @@
# Tips and Tricks for the data directory
# Structuring the `/data` Directory
The filename should contain information about the date
German version: [README_de.md](README_de.md)
```
project-name/
├── data/
├── raw/ # Original, unmodified data
├── processed/ # Data derived from raw data
└── models/ # Model weights and outputs (if applicable)
```
## Guidelines
- **`raw/`**:
- Store all original data exactly as collected.
- **Do not modify** these files to preserve data integrity.
- Include metadata or use clear filenames with dates to indicate when the data was recorded.
- **`processed/`**:
- Place cleaned or transformed data here.
- Generate these files using scripts.
- Document processing steps if necessary.
- **`models/`** (if you are training models):
- Save model weights, checkpoints, and outputs.
- Organize by experiment or model version if needed.
- Include metadata about training parameters or results.

26
data/README_de.md Normal file
View File

@@ -0,0 +1,26 @@
# Strukturierung des `/data`-Verzeichnisses
```
project-name/
├── data/
├── raw/ # Originale, unveränderte Daten
├── processed/ # Aus Rohdaten abgeleitete Daten
└── models/ # Modellgewichte und Ausgaben (optional)
```
## Richtlinien
- **`raw/`**:
- Speichere alle originalen Daten genau so, wie sie gesammelt wurden.
- **Verändere diese Dateien nicht**, um die Datenintegrität zu bewahren.
- Füge Metadaten hinzu oder verwende klare Dateinamen mit Datumsangaben, um anzugeben, wann die Daten aufgezeichnet wurden.
- **`processed/`**:
- Lege hier bereinigte oder transformierte Daten ab.
- Erstelle diese Dateien mithilfe von Skripten.
- Dokumentiere bei Bedarf die Verarbeitungsschritte.
- **`models/`** (falls du machine learning verwendest):
- Speichere Modellgewichte, Checkpoints und Ausgaben.
- Organisiere nach Experiment oder Modellversion, falls erforderlich.
- Füge Metadaten über Trainingsparameter oder Ergebnisse hinzu.