quocnam1012 meganariley HF Staff commited on
Commit
6f1bd46
·
0 Parent(s):

Duplicate from meganariley/shelter-dogs

Browse files

Co-authored-by: Megan Riley <meganariley@users.noreply.huggingface.co>

Files changed (3) hide show
  1. .gitattributes +60 -0
  2. README.md +90 -0
  3. data/train-00000-of-00001.parquet +3 -0
.gitattributes ADDED
@@ -0,0 +1,60 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ *.7z filter=lfs diff=lfs merge=lfs -text
2
+ *.arrow filter=lfs diff=lfs merge=lfs -text
3
+ *.avro filter=lfs diff=lfs merge=lfs -text
4
+ *.bin filter=lfs diff=lfs merge=lfs -text
5
+ *.bz2 filter=lfs diff=lfs merge=lfs -text
6
+ *.ckpt filter=lfs diff=lfs merge=lfs -text
7
+ *.ftz filter=lfs diff=lfs merge=lfs -text
8
+ *.gz filter=lfs diff=lfs merge=lfs -text
9
+ *.h5 filter=lfs diff=lfs merge=lfs -text
10
+ *.joblib filter=lfs diff=lfs merge=lfs -text
11
+ *.lfs.* filter=lfs diff=lfs merge=lfs -text
12
+ *.lz4 filter=lfs diff=lfs merge=lfs -text
13
+ *.mds filter=lfs diff=lfs merge=lfs -text
14
+ *.mlmodel filter=lfs diff=lfs merge=lfs -text
15
+ *.model filter=lfs diff=lfs merge=lfs -text
16
+ *.msgpack filter=lfs diff=lfs merge=lfs -text
17
+ *.npy filter=lfs diff=lfs merge=lfs -text
18
+ *.npz filter=lfs diff=lfs merge=lfs -text
19
+ *.onnx filter=lfs diff=lfs merge=lfs -text
20
+ *.ot filter=lfs diff=lfs merge=lfs -text
21
+ *.parquet filter=lfs diff=lfs merge=lfs -text
22
+ *.pb filter=lfs diff=lfs merge=lfs -text
23
+ *.pickle filter=lfs diff=lfs merge=lfs -text
24
+ *.pkl filter=lfs diff=lfs merge=lfs -text
25
+ *.pt filter=lfs diff=lfs merge=lfs -text
26
+ *.pth filter=lfs diff=lfs merge=lfs -text
27
+ *.rar filter=lfs diff=lfs merge=lfs -text
28
+ *.safetensors filter=lfs diff=lfs merge=lfs -text
29
+ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
30
+ *.tar.* filter=lfs diff=lfs merge=lfs -text
31
+ *.tar filter=lfs diff=lfs merge=lfs -text
32
+ *.tflite filter=lfs diff=lfs merge=lfs -text
33
+ *.tgz filter=lfs diff=lfs merge=lfs -text
34
+ *.wasm filter=lfs diff=lfs merge=lfs -text
35
+ *.xz filter=lfs diff=lfs merge=lfs -text
36
+ *.zip filter=lfs diff=lfs merge=lfs -text
37
+ *.zst filter=lfs diff=lfs merge=lfs -text
38
+ *tfevents* filter=lfs diff=lfs merge=lfs -text
39
+ # Audio files - uncompressed
40
+ *.pcm filter=lfs diff=lfs merge=lfs -text
41
+ *.sam filter=lfs diff=lfs merge=lfs -text
42
+ *.raw filter=lfs diff=lfs merge=lfs -text
43
+ # Audio files - compressed
44
+ *.aac filter=lfs diff=lfs merge=lfs -text
45
+ *.flac filter=lfs diff=lfs merge=lfs -text
46
+ *.mp3 filter=lfs diff=lfs merge=lfs -text
47
+ *.ogg filter=lfs diff=lfs merge=lfs -text
48
+ *.wav filter=lfs diff=lfs merge=lfs -text
49
+ # Image files - uncompressed
50
+ *.bmp filter=lfs diff=lfs merge=lfs -text
51
+ *.gif filter=lfs diff=lfs merge=lfs -text
52
+ *.png filter=lfs diff=lfs merge=lfs -text
53
+ *.tiff filter=lfs diff=lfs merge=lfs -text
54
+ # Image files - compressed
55
+ *.jpg filter=lfs diff=lfs merge=lfs -text
56
+ *.jpeg filter=lfs diff=lfs merge=lfs -text
57
+ *.webp filter=lfs diff=lfs merge=lfs -text
58
+ # Video files - compressed
59
+ *.mp4 filter=lfs diff=lfs merge=lfs -text
60
+ *.webm filter=lfs diff=lfs merge=lfs -text
README.md ADDED
@@ -0,0 +1,90 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: mit
3
+ task_categories:
4
+ - text-classification
5
+ - sentence-similarity
6
+ language:
7
+ - en
8
+ tags:
9
+ - dogs
10
+ - adoption
11
+ - shelter
12
+ - petfinder
13
+ - animals
14
+ - pets
15
+ size_categories:
16
+ - 10K<n<100K
17
+ pretty_name: US Shelter Dogs (PetFinder Snapshot)
18
+ ---
19
+
20
+ # 🐾 US Shelter Dogs — PetFinder Adoption Dataset
21
+
22
+ A cleaned and enriched dataset of **49,036 real adoptable dogs** from US shelters and rescues, originally collected from the PetFinder API on September 20, 2019.
23
+
24
+ ## Dataset Description
25
+
26
+ Each row represents a single adoptable dog with:
27
+ - **Rich text descriptions** written by shelters/rescues (median 708 characters)
28
+ - **Breed information** (216 unique breeds, primary + secondary + mixed flag)
29
+ - **Demographics**: age class, sex, size, coat type
30
+ - **Compatibility flags**: good with children, dogs, cats
31
+ - **Training/needs**: house trained, special needs, vaccination status
32
+ - **Location**: city and state
33
+ - **PetFinder URL**: direct link to the dog's original listing
34
+
35
+ ### `match_text` Column
36
+ A pre-built combined text field that merges the dog's structured metadata (name, breed, age, size, compatibility, training status) with their free-text description. Designed for semantic similarity matching with sentence-transformers.
37
+
38
+ ## Source
39
+
40
+ Originally collected by [Amber Thomas](https://pudding.cool/author/amber-thomas/) for The Pudding's essay ["Finding Forever Homes"](https://pudding.cool/2019/10/shelters/) (October 2019). Raw data from [the-pudding/data](https://github.com/the-pudding/data/tree/master/dog-shelters).
41
+
42
+ Data was collected via PetFinder's V2 API (`get-animals`) for all US states + DC. Descriptions were obtained via the V1 API. This dataset represents a single-day snapshot of all adoptable dogs on PetFinder.
43
+
44
+ ## Cleaning Applied
45
+
46
+ 1. Removed dogs without descriptions (8,705 rows) and very short descriptions < 30 chars (439 rows)
47
+ 2. Dropped administrative columns (`declawed`, `stateQ`, `accessed`, `type.x`, `type.y`, `org_id`, `contact_zip`, `contact_country`, `status`, `species`)
48
+ 3. Created `match_text` combining structured metadata + description for embedding
49
+ 4. Standardized boolean and compatibility columns
50
+
51
+ ## Column Reference
52
+
53
+ | Column | Type | Description |
54
+ |--------|------|-------------|
55
+ | `id` | int | Unique PetFinder ID |
56
+ | `url` | string | PetFinder listing URL |
57
+ | `name` | string | Dog's name |
58
+ | `breed_primary` | string | Primary breed (216 unique) |
59
+ | `breed_secondary` | string | Secondary breed (if mixed) |
60
+ | `breed_mixed` | bool | Whether mixed breed |
61
+ | `age` | string | Baby, Young, Adult, Senior |
62
+ | `sex` | string | Male, Female, Unknown |
63
+ | `size` | string | Small, Medium, Large, Extra Large |
64
+ | `coat` | string | Short, Medium, Long, Wire, Curly, Hairless |
65
+ | `env_children` | string | yes / no / unknown |
66
+ | `env_dogs` | string | yes / no / unknown |
67
+ | `env_cats` | string | yes / no / unknown |
68
+ | `house_trained` | bool | House trained status |
69
+ | `special_needs` | bool | Has special needs |
70
+ | `description` | string | Full shelter-written description |
71
+ | `match_text` | string | Combined metadata + description for embedding |
72
+ | `contact_city` | string | Shelter city |
73
+ | `contact_state` | string | Shelter state |
74
+
75
+ ## Usage
76
+
77
+ Used by the [Shelter Dog Personality Matcher](https://huggingface.co/spaces/meganariley/shelter-dog-matcher) Gradio Space — a quiz-based app that matches users to adoptable dogs using sentence-transformer semantic similarity.
78
+
79
+ ## Statistics
80
+
81
+ - **49,036** dogs with descriptions
82
+ - **216** unique primary breeds
83
+ - **Age**: Adult (57%), Young (33%), Baby (19%), Senior (9%)
84
+ - **Size**: Medium (61%), Large (32%), Small (24%), Extra Large (2%)
85
+ - **Top breeds**: Pit Bull Terrier, Labrador Retriever, Chihuahua, Mixed Breed, Terrier
86
+ - **All 50 US states + DC** represented
87
+
88
+ ## License
89
+
90
+ The original data was collected from the publicly available PetFinder API. Released under MIT license for research and educational purposes.
data/train-00000-of-00001.parquet ADDED
@@ -0,0 +1,3 @@
 
 
 
 
1
+ version https://git-lfs.github.com/spec/v1
2
+ oid sha256:6329c0329295ba7793ed54e5cec73dc709818f1eae0b11d24e30529ef48e35f6
3
+ size 45385990