Khoa Duy Nguyen commited on
Commit
1263f4e
·
1 Parent(s): dc5a371

add YAML section to README

Browse files
Files changed (1) hide show
  1. README.md +25 -0
README.md CHANGED
@@ -48,3 +48,28 @@ iris-1/
48
 
49
  The data within the `mock` and `private` directories is saved in Apache Arrow format.
50
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
48
 
49
  The data within the `mock` and `private` directories is saved in Apache Arrow format.
50
 
51
+ ```yaml
52
+ dataset_info:
53
+ name: Iris Dataset
54
+ description: A classic dataset in machine learning consisting of 150 samples of iris flowers.
55
+ features:
56
+ - SepalLengthCm: float
57
+ - SepalWidthCm: float
58
+ - PetalLengthCm: float
59
+ - PetalWidthCm: float
60
+ targets:
61
+ - Species: string (Iris-setosa, Iris-versicolor, Iris-virginica)
62
+ size: 150 samples
63
+ source: https://archive.ics.uci.edu/ml/datasets/iris
64
+ partitioned: true
65
+ partitions:
66
+ count: 5 (default, configurable in dataset.py)
67
+ structure:
68
+ mock:
69
+ description: 10% of the partition's data, public.
70
+ format: Apache Arrow
71
+ private:
72
+ description: 90% of the partition's data, confidential.
73
+ format: Apache Arrow
74
+ ```
75
+