Update README.md
Browse files
README.md
CHANGED
@@ -1,3 +1,68 @@
|
|
1 |
---
|
2 |
license: mit
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3 |
---
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
---
|
2 |
license: mit
|
3 |
+
metrics:
|
4 |
+
- accuracy
|
5 |
+
- precision
|
6 |
+
- recall
|
7 |
+
- f1
|
8 |
+
library_name: sklearn
|
9 |
+
pipeline_tag: tabular-classification
|
10 |
+
tags:
|
11 |
+
- biology
|
12 |
---
|
13 |
+
|
14 |
+
# Palmer Penguins Species Classifier
|
15 |
+
|
16 |
+
## Model description
|
17 |
+
|
18 |
+
This model is a scikit-learn classifier trained to predict the species of penguins in the Palmer Penguins dataset.
|
19 |
+
The dataset contains measurements of penguin species including the species itself, making it suitable for classification tasks.
|
20 |
+
|
21 |
+
The model uses features such as culmen length, culmen depth, flipper length, and body mass to predict the species of penguins.
|
22 |
+
|
23 |
+
## Intended uses & limitations
|
24 |
+
|
25 |
+
The model is intended for classifying the species of penguins based on their physical measurements.
|
26 |
+
It can be used in applications related to penguin species classification and analysis.
|
27 |
+
|
28 |
+
Limitations:
|
29 |
+
- The model's performance may vary depending on the quality and representativeness of the input data.
|
30 |
+
- It is trained specifically on the Palmer Penguins dataset and may not generalize well to other penguin datasets or species outside of the dataset.
|
31 |
+
|
32 |
+
## Training data
|
33 |
+
|
34 |
+
The model is trained on the Palmer Penguins dataset, which contains measurements of penguin species including Adelie, Chinstrap, and Gentoo.
|
35 |
+
The dataset is publicly available and can be accessed [here](https://github.com/allisonhorst/palmerpenguins).
|
36 |
+
|
37 |
+
## Training procedure
|
38 |
+
|
39 |
+
The model is trained using scikit-learn, a popular machine learning library in Python.
|
40 |
+
It uses a classification algorithm (e.g., Random Forest, Support Vector Machine) to learn the relationship between the input features (culmen length, culmen depth, flipper length, body mass) and the target variable (species).
|
41 |
+
|
42 |
+
## Model in action
|
43 |
+
|
44 |
+
```python
|
45 |
+
# Load the model
|
46 |
+
from sklearn.externals import joblib
|
47 |
+
|
48 |
+
model = joblib.load('path/to/your/model.pkl')
|
49 |
+
|
50 |
+
# Input features
|
51 |
+
features = {
|
52 |
+
'culmen_length_mm': 39.1,
|
53 |
+
'culmen_depth_mm': 18.7,
|
54 |
+
'flipper_length_mm': 181,
|
55 |
+
'body_mass_g': 3750
|
56 |
+
}
|
57 |
+
|
58 |
+
# Predict species
|
59 |
+
predicted_species = model.predict([list(features.values())])[0]
|
60 |
+
print(f"Predicted species: {predicted_species}")
|
61 |
+
```
|
62 |
+
|
63 |
+
|
64 |
+
### π§ Disclaimer
|
65 |
+
|
66 |
+
No penguins were harmed while training this model π§.
|
67 |
+
|
68 |
+
We were noot involved in collecting the π§ data.
|