-
Notifications
You must be signed in to change notification settings - Fork 81
/
Copy pathfaq.html
1264 lines (1027 loc) · 79.4 KB
/
faq.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en" data-content_root="./" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta property="og:title" content="Frequently Asked Questions" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://scikit-learn/stable/faq.html" />
<meta property="og:site_name" content="scikit-learn" />
<meta property="og:description" content="Here we try to give some answers to questions that regularly pop up on the mailing list. Table of Contents: About the project- What is the project name (a lot of people get it wrong)?, How do you p..." />
<meta property="og:image" content="https://scikit-learn.org/stable/_static/scikit-learn-logo-small.png" />
<meta property="og:image:alt" content="scikit-learn" />
<meta name="description" content="Here we try to give some answers to questions that regularly pop up on the mailing list. Table of Contents: About the project- What is the project name (a lot of people get it wrong)?, How do you p..." />
<title>Frequently Asked Questions — scikit-learn 1.6.dev0 documentation</title>
<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
</script>
<!-- Loaded before other Sphinx assets -->
<link href="_static/styles/theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/bootstrap.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/styles/pydata-sphinx-theme.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link href="_static/vendor/fontawesome/6.5.2/css/all.min.css?digest=dfe6caa3a7d634c4db9b" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="_static/vendor/fontawesome/6.5.2/webfonts/fa-regular-400.woff2" />
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/plot_directive.css" />
<link rel="stylesheet" type="text/css" href="https://fonts.googleapis.com/css?family=Vibur" />
<link rel="stylesheet" type="text/css" href="_static/jupyterlite_sphinx.css?v=ca70e7f1" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery.css?v=d2d258e8" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-binder.css?v=f4aeca0c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-dataframe.css?v=2082cf3c" />
<link rel="stylesheet" type="text/css" href="_static/sg_gallery-rendered-html.css?v=1277b6f3" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="_static/styles/colors.css?v=cc94ab7d" />
<link rel="stylesheet" type="text/css" href="_static/styles/custom.css?v=e4cb1417" />
<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=dfe6caa3a7d634c4db9b" />
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
<script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
<script src="_static/documentation_options.js?v=d875d36e"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=97f0b27d"></script>
<script src="_static/jupyterlite_sphinx.js?v=d6bdf5f8"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script data-domain="scikit-learn.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
<script>DOCUMENTATION_OPTIONS.pagename = 'faq';</script>
<script>
DOCUMENTATION_OPTIONS.theme_version = '0.15.4';
DOCUMENTATION_OPTIONS.theme_switcher_json_url = 'https://scikit-learn.org/dev/_static/versions.json';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '1.6.dev0';
DOCUMENTATION_OPTIONS.show_version_warning_banner = true;
</script>
<script src="_static/scripts/dropdown.js?v=e2048168"></script>
<script src="_static/scripts/version-switcher.js?v=a6dd8357"></script>
<link rel="icon" href="_static/favicon.ico"/>
<link rel="author" title="About these documents" href="about.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Support" href="support.html" />
<link rel="prev" title="Developing with the Plotting API" href="developers/plotting.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
<div id="pst-scroll-pixel-helper"></div>
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
<input type="checkbox"
class="sidebar-toggle"
id="pst-primary-sidebar-checkbox"/>
<label class="overlay overlay-primary" for="pst-primary-sidebar-checkbox"></label>
<input type="checkbox"
class="sidebar-toggle"
id="pst-secondary-sidebar-checkbox"/>
<label class="overlay overlay-secondary" for="pst-secondary-sidebar-checkbox"></label>
<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search the docs ..."
aria-label="Search the docs ..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>
<div class="pst-async-banner-revealer d-none">
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
</div>
<aside class="bd-header-announcement" aria-label="Announcement">
<div class="bd-header-announcement__content"><a href="https://forms.gle/zUXvWjGUN1nWhJ2V6">Help us make <code>scikit-learn</code> better! The 2024 user survey is now live.</a></div>
</aside>
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
<div class="bd-header__inner bd-page-width">
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
<span class="fa-solid fa-bars"></span>
</button>
<div class=" navbar-header-items__start">
<div class="navbar-item">
<a class="navbar-brand logo" href="index.html">
<img src="_static/scikit-learn-logo-small.png" class="logo__image only-light" alt="scikit-learn homepage"/>
<script>document.write(`<img src="_static/scikit-learn-logo-small.png" class="logo__image only-dark" alt="scikit-learn homepage"/>`);</script>
</a></div>
</div>
<div class=" navbar-header-items">
<div class="me-auto navbar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="install.html">
Install
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="user_guide.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api/index.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="auto_examples/index.html">
Examples
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://blog.scikit-learn.org/">
Community
</a>
</li>
<li class="nav-item dropdown">
<button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links">
More
</button>
<ul id="pst-nav-more-links" class="dropdown-menu">
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="getting_started.html">
Getting Started
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="whats_new.html">
Release History
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="glossary.html">
Glossary
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="developers/index.html">
Development
</a>
</li>
<li class=" current active">
<a class="nav-link dropdown-item nav-internal" href="#">
FAQ
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="support.html">
Support
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="related_projects.html">
Related Projects
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="roadmap.html">
Roadmap
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="governance.html">
Governance
</a>
</li>
<li class=" ">
<a class="nav-link dropdown-item nav-internal" href="about.html">
About us
</a>
</li>
</ul>
</li>
</ul>
</nav></div>
</div>
<div class="navbar-header-items__end">
<div class="navbar-item navbar-persistent--container">
<script>
document.write(`
<button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
`);
</script>
</div>
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/scikit-learn/scikit-learn" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
<div class="navbar-item">
<script>
document.write(`
<div class="version-switcher__container dropdown">
<button id="pst-version-switcher-button-2"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-2"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-2"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-2">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
`);
</script></div>
</div>
</div>
<div class="navbar-persistent--mobile">
<script>
document.write(`
<button class="btn btn-sm pst-navbar-icon search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass fa-lg"></i>
</button>
`);
</script>
</div>
<button class="pst-navbar-icon sidebar-toggle secondary-toggle" aria-label="On this page">
<span class="fa-solid fa-outdent"></span>
</button>
</div>
</header>
<div class="bd-container">
<div class="bd-container__inner bd-page-width">
<div class="bd-sidebar-primary bd-sidebar hide-on-wide">
<div class="sidebar-header-items sidebar-primary__section">
<div class="sidebar-header-items__center">
<div class="navbar-item">
<nav>
<ul class="bd-navbar-elements navbar-nav">
<li class="nav-item ">
<a class="nav-link nav-internal" href="install.html">
Install
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="user_guide.html">
User Guide
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="api/index.html">
API
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="auto_examples/index.html">
Examples
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-external" href="https://blog.scikit-learn.org/">
Community
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="getting_started.html">
Getting Started
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="whats_new.html">
Release History
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="glossary.html">
Glossary
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="developers/index.html">
Development
</a>
</li>
<li class="nav-item current active">
<a class="nav-link nav-internal" href="#">
FAQ
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="support.html">
Support
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="related_projects.html">
Related Projects
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="roadmap.html">
Roadmap
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="governance.html">
Governance
</a>
</li>
<li class="nav-item ">
<a class="nav-link nav-internal" href="about.html">
About us
</a>
</li>
</ul>
</nav></div>
</div>
<div class="sidebar-header-items__end">
<div class="navbar-item">
<script>
document.write(`
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light"></i>
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark"></i>
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto"></i>
</button>
`);
</script></div>
<div class="navbar-item"><ul class="navbar-icon-links"
aria-label="Icon Links">
<li class="nav-item">
<a href="https://github.com/scikit-learn/scikit-learn" title="GitHub" class="nav-link pst-navbar-icon" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i>
<span class="sr-only">GitHub</span></a>
</li>
</ul></div>
<div class="navbar-item">
<script>
document.write(`
<div class="version-switcher__container dropdown">
<button id="pst-version-switcher-button-3"
type="button"
class="version-switcher__button btn btn-sm dropdown-toggle"
data-bs-toggle="dropdown"
aria-haspopup="listbox"
aria-controls="pst-version-switcher-list-3"
aria-label="Version switcher list"
>
Choose version <!-- this text may get changed later by javascript -->
<span class="caret"></span>
</button>
<div id="pst-version-switcher-list-3"
class="version-switcher__menu dropdown-menu list-group-flush py-0"
role="listbox" aria-labelledby="pst-version-switcher-button-3">
<!-- dropdown will be populated by javascript on page load -->
</div>
</div>
`);
</script></div>
</div>
</div>
<div class="sidebar-primary-items__end sidebar-primary__section">
</div>
<div id="rtd-footer-container"></div>
</div>
<main id="main-content" class="bd-main" role="main">
<div class="bd-content">
<div class="bd-article-container">
<div class="bd-header-article d-print-none">
<div class="header-article-items header-article__inner">
<div class="header-article-items__start">
<div class="header-article-item">
<nav aria-label="Breadcrumb" class="d-print-none">
<ul class="bd-breadcrumbs">
<li class="breadcrumb-item breadcrumb-home">
<a href="index.html" class="nav-link" aria-label="Home">
<i class="fa-solid fa-home"></i>
</a>
</li>
<li class="breadcrumb-item active" aria-current="page">Frequently...</li>
</ul>
</nav>
</div>
</div>
</div>
</div>
<div id="searchbox"></div>
<article class="bd-article">
<style>
/* h3 headings on this page are the questions; make them rubric-like */
h3 {
font-size: 1rem;
font-weight: bold;
padding-bottom: 0.2rem;
margin: 2rem 0 1.15rem 0;
border-bottom: 1px solid var(--pst-color-border);
}
/* Increase top margin for first question in each section */
h2 + section > h3 {
margin-top: 2.5rem;
}
/* Make the headerlinks a bit more visible */
h3 > a.headerlink {
font-size: 0.9rem;
}
/* Remove the backlink decoration on the titles */
h2 > a.toc-backref,
h3 > a.toc-backref {
text-decoration: none;
}
</style><section id="frequently-asked-questions">
<span id="faq"></span><h1>Frequently Asked Questions<a class="headerlink" href="#frequently-asked-questions" title="Link to this heading">#</a></h1>
<p>Here we try to give some answers to questions that regularly pop up on the mailing list.</p>
<nav class="contents local" id="table-of-contents">
<p class="topic-title">Table of Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#about-the-project" id="id2">About the project</a></p>
<ul>
<li><p><a class="reference internal" href="#what-is-the-project-name-a-lot-of-people-get-it-wrong" id="id3">What is the project name (a lot of people get it wrong)?</a></p></li>
<li><p><a class="reference internal" href="#how-do-you-pronounce-the-project-name" id="id4">How do you pronounce the project name?</a></p></li>
<li><p><a class="reference internal" href="#why-scikit" id="id5">Why scikit?</a></p></li>
<li><p><a class="reference internal" href="#do-you-support-pypy" id="id6">Do you support PyPy?</a></p></li>
<li><p><a class="reference internal" href="#how-can-i-obtain-permission-to-use-the-images-in-scikit-learn-for-my-work" id="id7">How can I obtain permission to use the images in scikit-learn for my work?</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#implementation-decisions" id="id8">Implementation decisions</a></p>
<ul>
<li><p><a class="reference internal" href="#why-is-there-no-support-for-deep-or-reinforcement-learning-will-there-be-such-support-in-the-future" id="id9">Why is there no support for deep or reinforcement learning? Will there be such support in the future?</a></p></li>
<li><p><a class="reference internal" href="#will-you-add-graphical-models-or-sequence-prediction-to-scikit-learn" id="id10">Will you add graphical models or sequence prediction to scikit-learn?</a></p></li>
<li><p><a class="reference internal" href="#why-did-you-remove-hmms-from-scikit-learn" id="id11">Why did you remove HMMs from scikit-learn?</a></p></li>
<li><p><a class="reference internal" href="#will-you-add-gpu-support" id="id12">Will you add GPU support?</a></p></li>
<li><p><a class="reference internal" href="#why-do-categorical-variables-need-preprocessing-in-scikit-learn-compared-to-other-tools" id="id13">Why do categorical variables need preprocessing in scikit-learn, compared to other tools?</a></p></li>
<li><p><a class="reference internal" href="#why-does-scikit-learn-not-directly-work-with-for-example-pandas-dataframe" id="id14">Why does scikit-learn not directly work with, for example, <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code></a>?</a></p></li>
<li><p><a class="reference internal" href="#do-you-plan-to-implement-transform-for-target-y-in-a-pipeline" id="id15">Do you plan to implement transform for target <code class="docutils literal notranslate"><span class="pre">y</span></code> in a pipeline?</a></p></li>
<li><p><a class="reference internal" href="#why-are-there-so-many-different-estimators-for-linear-models" id="id16">Why are there so many different estimators for linear models?</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#contributing" id="id17">Contributing</a></p>
<ul>
<li><p><a class="reference internal" href="#how-can-i-contribute-to-scikit-learn" id="id18">How can I contribute to scikit-learn?</a></p></li>
<li><p><a class="reference internal" href="#why-is-my-pull-request-not-getting-any-attention" id="id19">Why is my pull request not getting any attention?</a></p></li>
<li><p><a class="reference internal" href="#what-are-the-inclusion-criteria-for-new-algorithms" id="id20">What are the inclusion criteria for new algorithms?</a></p></li>
<li><p><a class="reference internal" href="#why-are-you-so-selective-on-what-algorithms-you-include-in-scikit-learn" id="id21">Why are you so selective on what algorithms you include in scikit-learn?</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#using-scikit-learn" id="id22">Using scikit-learn</a></p>
<ul>
<li><p><a class="reference internal" href="#what-s-the-best-way-to-get-help-on-scikit-learn-usage" id="id23">What’s the best way to get help on scikit-learn usage?</a></p></li>
<li><p><a class="reference internal" href="#how-should-i-save-export-or-deploy-estimators-for-production" id="id24">How should I save, export or deploy estimators for production?</a></p></li>
<li><p><a class="reference internal" href="#how-can-i-create-a-bunch-object" id="id25">How can I create a bunch object?</a></p></li>
<li><p><a class="reference internal" href="#how-can-i-load-my-own-datasets-into-a-format-usable-by-scikit-learn" id="id26">How can I load my own datasets into a format usable by scikit-learn?</a></p></li>
<li><p><a class="reference internal" href="#how-do-i-deal-with-string-data-or-trees-graphs" id="id27">How do I deal with string data (or trees, graphs…)?</a></p></li>
<li><p><a class="reference internal" href="#why-do-i-sometimes-get-a-crash-freeze-with-n-jobs-1-under-osx-or-linux" id="id28">Why do I sometimes get a crash/freeze with <code class="docutils literal notranslate"><span class="pre">n_jobs</span> <span class="pre">></span> <span class="pre">1</span></code> under OSX or Linux?</a></p></li>
<li><p><a class="reference internal" href="#why-does-my-job-use-more-cores-than-specified-with-n-jobs" id="id29">Why does my job use more cores than specified with <code class="docutils literal notranslate"><span class="pre">n_jobs</span></code>?</a></p></li>
<li><p><a class="reference internal" href="#how-do-i-set-a-random-state-for-an-entire-execution" id="id30">How do I set a <code class="docutils literal notranslate"><span class="pre">random_state</span></code> for an entire execution?</a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="about-the-project">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">About the project</a><a class="headerlink" href="#about-the-project" title="Link to this heading">#</a></h2>
<section id="what-is-the-project-name-a-lot-of-people-get-it-wrong">
<h3><a class="toc-backref" href="#id3" role="doc-backlink">What is the project name (a lot of people get it wrong)?</a><a class="headerlink" href="#what-is-the-project-name-a-lot-of-people-get-it-wrong" title="Link to this heading">#</a></h3>
<p>scikit-learn, but not scikit or SciKit nor sci-kit learn.
Also not scikits.learn or scikits-learn, which were previously used.</p>
</section>
<section id="how-do-you-pronounce-the-project-name">
<h3><a class="toc-backref" href="#id4" role="doc-backlink">How do you pronounce the project name?</a><a class="headerlink" href="#how-do-you-pronounce-the-project-name" title="Link to this heading">#</a></h3>
<p>sy-kit learn. sci stands for science!</p>
</section>
<section id="why-scikit">
<h3><a class="toc-backref" href="#id5" role="doc-backlink">Why scikit?</a><a class="headerlink" href="#why-scikit" title="Link to this heading">#</a></h3>
<p>There are multiple scikits, which are scientific toolboxes built around SciPy.
Apart from scikit-learn, another popular one is <a class="reference external" href="https://scikit-image.org/">scikit-image</a>.</p>
</section>
<section id="do-you-support-pypy">
<h3><a class="toc-backref" href="#id6" role="doc-backlink">Do you support PyPy?</a><a class="headerlink" href="#do-you-support-pypy" title="Link to this heading">#</a></h3>
<p>Due to limited maintainer resources and small number of users, using
scikit-learn with <a class="reference external" href="https://pypy.org/">PyPy</a> (an alternative Python
implementation with a built-in just-in-time compiler) is not officially
supported.</p>
</section>
<section id="how-can-i-obtain-permission-to-use-the-images-in-scikit-learn-for-my-work">
<h3><a class="toc-backref" href="#id7" role="doc-backlink">How can I obtain permission to use the images in scikit-learn for my work?</a><a class="headerlink" href="#how-can-i-obtain-permission-to-use-the-images-in-scikit-learn-for-my-work" title="Link to this heading">#</a></h3>
<p>The images contained in the <a class="reference external" href="https://github.com/scikit-learn/scikit-learn">scikit-learn repository</a> and the images generated within
the <a class="reference external" href="https://scikit-learn.org/stable/index.html">scikit-learn documentation</a>
can be used via the <a class="reference external" href="https://github.com/scikit-learn/scikit-learn?tab=BSD-3-Clause-1-ov-file">BSD 3-Clause License</a> for
your work. Citations of scikit-learn are highly encouraged and appreciated. See
<a class="reference internal" href="about.html#citing-scikit-learn"><span class="std std-ref">citing scikit-learn</span></a>.</p>
</section>
</section>
<section id="implementation-decisions">
<h2><a class="toc-backref" href="#id8" role="doc-backlink">Implementation decisions</a><a class="headerlink" href="#implementation-decisions" title="Link to this heading">#</a></h2>
<section id="why-is-there-no-support-for-deep-or-reinforcement-learning-will-there-be-such-support-in-the-future">
<h3><a class="toc-backref" href="#id9" role="doc-backlink">Why is there no support for deep or reinforcement learning? Will there be such support in the future?</a><a class="headerlink" href="#why-is-there-no-support-for-deep-or-reinforcement-learning-will-there-be-such-support-in-the-future" title="Link to this heading">#</a></h3>
<p>Deep learning and reinforcement learning both require a rich vocabulary to
define an architecture, with deep learning additionally requiring
GPUs for efficient computing. However, neither of these fit within
the design constraints of scikit-learn. As a result, deep learning
and reinforcement learning are currently out of scope for what
scikit-learn seeks to achieve.</p>
<p>You can find more information about the addition of GPU support at
<a class="reference internal" href="#will-you-add-gpu-support">Will you add GPU support?</a>.</p>
<p>Note that scikit-learn currently implements a simple multilayer perceptron
in <a class="reference internal" href="api/sklearn.neural_network.html#module-sklearn.neural_network" title="sklearn.neural_network"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sklearn.neural_network</span></code></a>. We will only accept bug fixes for this module.
If you want to implement more complex deep learning models, please turn to
popular deep learning frameworks such as
<a class="reference external" href="https://www.tensorflow.org/">tensorflow</a>,
<a class="reference external" href="https://keras.io/">keras</a>,
and <a class="reference external" href="https://pytorch.org/">pytorch</a>.</p>
</section>
<section id="will-you-add-graphical-models-or-sequence-prediction-to-scikit-learn">
<span id="adding-graphical-models"></span><h3><a class="toc-backref" href="#id10" role="doc-backlink">Will you add graphical models or sequence prediction to scikit-learn?</a><a class="headerlink" href="#will-you-add-graphical-models-or-sequence-prediction-to-scikit-learn" title="Link to this heading">#</a></h3>
<p>Not in the foreseeable future.
scikit-learn tries to provide a unified API for the basic tasks in machine
learning, with pipelines and meta-algorithms like grid search to tie
everything together. The required concepts, APIs, algorithms and
expertise required for structured learning are different from what
scikit-learn has to offer. If we started doing arbitrary structured
learning, we’d need to redesign the whole package and the project
would likely collapse under its own weight.</p>
<p>There are two projects with API similar to scikit-learn that
do structured prediction:</p>
<ul class="simple">
<li><p><a class="reference external" href="https://pystruct.github.io/">pystruct</a> handles general structured
learning (focuses on SSVMs on arbitrary graph structures with
approximate inference; defines the notion of sample as an instance of
the graph structure).</p></li>
<li><p><a class="reference external" href="https://larsmans.github.io/seqlearn/">seqlearn</a> handles sequences only
(focuses on exact inference; has HMMs, but mostly for the sake of
completeness; treats a feature vector as a sample and uses an offset encoding
for the dependencies between feature vectors).</p></li>
</ul>
</section>
<section id="why-did-you-remove-hmms-from-scikit-learn">
<h3><a class="toc-backref" href="#id11" role="doc-backlink">Why did you remove HMMs from scikit-learn?</a><a class="headerlink" href="#why-did-you-remove-hmms-from-scikit-learn" title="Link to this heading">#</a></h3>
<p>See <a class="reference internal" href="#adding-graphical-models"><span class="std std-ref">Will you add graphical models or sequence prediction to scikit-learn?</span></a>.</p>
</section>
<section id="will-you-add-gpu-support">
<h3><a class="toc-backref" href="#id12" role="doc-backlink">Will you add GPU support?</a><a class="headerlink" href="#will-you-add-gpu-support" title="Link to this heading">#</a></h3>
<p>Adding GPU support by default would introduce heavy harware-specific software
dependencies and existing algorithms would need to be reimplemented. This would
make it both harder for the average user to install scikit-learn and harder for
the developers to maintain the code.</p>
<p>However, since 2023, a limited but growing <a class="reference internal" href="modules/array_api.html#array-api-supported"><span class="std std-ref">list of scikit-learn
estimators</span></a> can already run on GPUs if the input data is
provided as a PyTorch or CuPy array and if scikit-learn has been configured to
accept such inputs as explained in <a class="reference internal" href="modules/array_api.html#array-api"><span class="std std-ref">Array API support (experimental)</span></a>. This Array API support
allows scikit-learn to run on GPUs without introducing heavy and
hardware-specific software dependencies to the main package.</p>
<p>Most estimators that rely on NumPy for their computationally intensive operations
can be considered for Array API support and therefore GPU support.</p>
<p>However, not all scikit-learn estimators are amenable to efficiently running
on GPUs via the Array API for fundamental algorithmic reasons. For instance,
tree-based models currently implemented with Cython in scikit-learn are
fundamentally not array-based algorithms. Other algorithms such as k-means or
k-nearest neighbors rely on array-based algorithms but are also implemented in
Cython. Cython is used to manually interleave consecutive array operations to
avoid introducing performance killing memory access to large intermediate
arrays: this low-level algorithmic rewrite is called “kernel fusion” and cannot
be expressed via the Array API for the foreseeable future.</p>
<p>Adding efficient GPU support to estimators that cannot be efficiently
implemented with the Array API would require designing and adopting a more
flexible extension system for scikit-learn. This possibility is being
considered in the following GitHub issue (under discussion):</p>
<ul class="simple">
<li><p><a class="github reference external" href="https://github.com/scikit-learn/scikit-learn/issues/22438">scikit-learn/scikit-learn#22438</a></p></li>
</ul>
</section>
<section id="why-do-categorical-variables-need-preprocessing-in-scikit-learn-compared-to-other-tools">
<h3><a class="toc-backref" href="#id13" role="doc-backlink">Why do categorical variables need preprocessing in scikit-learn, compared to other tools?</a><a class="headerlink" href="#why-do-categorical-variables-need-preprocessing-in-scikit-learn-compared-to-other-tools" title="Link to this heading">#</a></h3>
<p>Most of scikit-learn assumes data is in NumPy arrays or SciPy sparse matrices
of a single numeric dtype. These do not explicitly represent categorical
variables at present. Thus, unlike R’s <code class="docutils literal notranslate"><span class="pre">data.frames</span></code> or <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code></a>,
we require explicit conversion of categorical features to numeric values, as
discussed in <a class="reference internal" href="modules/preprocessing.html#preprocessing-categorical-features"><span class="std std-ref">Encoding categorical features</span></a>.
See also <a class="reference internal" href="auto_examples/compose/plot_column_transformer_mixed_types.html#sphx-glr-auto-examples-compose-plot-column-transformer-mixed-types-py"><span class="std std-ref">Column Transformer with Mixed Types</span></a> for an
example of working with heterogeneous (e.g. categorical and numeric) data.</p>
</section>
<section id="why-does-scikit-learn-not-directly-work-with-for-example-pandas-dataframe">
<h3><a class="toc-backref" href="#id14" role="doc-backlink">Why does scikit-learn not directly work with, for example, <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html#pandas.DataFrame" title="(in pandas v2.2.2)"><code class="xref py py-class docutils literal notranslate"><span class="pre">pandas.DataFrame</span></code></a>?</a><a class="headerlink" href="#why-does-scikit-learn-not-directly-work-with-for-example-pandas-dataframe" title="Link to this heading">#</a></h3>
<p>The homogeneous NumPy and SciPy data objects currently expected are most
efficient to process for most operations. Extensive work would also be needed
to support Pandas categorical types. Restricting input to homogeneous
types therefore reduces maintenance cost and encourages usage of efficient
data structures.</p>
<p>Note however that <a class="reference internal" href="modules/generated/sklearn.compose.ColumnTransformer.html#sklearn.compose.ColumnTransformer" title="sklearn.compose.ColumnTransformer"><code class="xref py py-class docutils literal notranslate"><span class="pre">ColumnTransformer</span></code></a> makes it
convenient to handle heterogeneous pandas dataframes by mapping homogeneous subsets of
dataframe columns selected by name or dtype to dedicated scikit-learn transformers.
Therefore <a class="reference internal" href="modules/generated/sklearn.compose.ColumnTransformer.html#sklearn.compose.ColumnTransformer" title="sklearn.compose.ColumnTransformer"><code class="xref py py-class docutils literal notranslate"><span class="pre">ColumnTransformer</span></code></a> are often used in the first
step of scikit-learn pipelines when dealing
with heterogeneous dataframes (see <a class="reference internal" href="modules/compose.html#pipeline"><span class="std std-ref">Pipeline: chaining estimators</span></a> for more details).</p>
<p>See also <a class="reference internal" href="auto_examples/compose/plot_column_transformer_mixed_types.html#sphx-glr-auto-examples-compose-plot-column-transformer-mixed-types-py"><span class="std std-ref">Column Transformer with Mixed Types</span></a>
for an example of working with heterogeneous (e.g. categorical and numeric) data.</p>
</section>
<section id="do-you-plan-to-implement-transform-for-target-y-in-a-pipeline">
<h3><a class="toc-backref" href="#id15" role="doc-backlink">Do you plan to implement transform for target <code class="docutils literal notranslate"><span class="pre">y</span></code> in a pipeline?</a><a class="headerlink" href="#do-you-plan-to-implement-transform-for-target-y-in-a-pipeline" title="Link to this heading">#</a></h3>
<p>Currently transform only works for features <code class="docutils literal notranslate"><span class="pre">X</span></code> in a pipeline. There’s a
long-standing discussion about not being able to transform <code class="docutils literal notranslate"><span class="pre">y</span></code> in a pipeline.
Follow on GitHub issue <a class="reference external" href="https://github.com/scikit-learn/scikit-learn/issues/4143">#4143</a>. Meanwhile, you can check out
<a class="reference internal" href="modules/generated/sklearn.compose.TransformedTargetRegressor.html#sklearn.compose.TransformedTargetRegressor" title="sklearn.compose.TransformedTargetRegressor"><code class="xref py py-class docutils literal notranslate"><span class="pre">TransformedTargetRegressor</span></code></a>,
<a class="reference external" href="https://github.com/mcasl/PipeGraph">pipegraph</a>,
and <a class="reference external" href="https://github.com/scikit-learn-contrib/imbalanced-learn">imbalanced-learn</a>.
Note that scikit-learn solved for the case where <code class="docutils literal notranslate"><span class="pre">y</span></code>
has an invertible transformation applied before training
and inverted after prediction. scikit-learn intends to solve for
use cases where <code class="docutils literal notranslate"><span class="pre">y</span></code> should be transformed at training time
and not at test time, for resampling and similar uses, like at
<a class="reference external" href="https://github.com/scikit-learn-contrib/imbalanced-learn">imbalanced-learn</a>.
In general, these use cases can be solved
with a custom meta estimator rather than a <a class="reference internal" href="modules/generated/sklearn.pipeline.Pipeline.html#sklearn.pipeline.Pipeline" title="sklearn.pipeline.Pipeline"><code class="xref py py-class docutils literal notranslate"><span class="pre">Pipeline</span></code></a>.</p>
</section>
<section id="why-are-there-so-many-different-estimators-for-linear-models">
<h3><a class="toc-backref" href="#id16" role="doc-backlink">Why are there so many different estimators for linear models?</a><a class="headerlink" href="#why-are-there-so-many-different-estimators-for-linear-models" title="Link to this heading">#</a></h3>
<p>Usually, there is one classifier and one regressor per model type, e.g.
<a class="reference internal" href="modules/generated/sklearn.ensemble.GradientBoostingClassifier.html#sklearn.ensemble.GradientBoostingClassifier" title="sklearn.ensemble.GradientBoostingClassifier"><code class="xref py py-class docutils literal notranslate"><span class="pre">GradientBoostingClassifier</span></code></a> and
<a class="reference internal" href="modules/generated/sklearn.ensemble.GradientBoostingRegressor.html#sklearn.ensemble.GradientBoostingRegressor" title="sklearn.ensemble.GradientBoostingRegressor"><code class="xref py py-class docutils literal notranslate"><span class="pre">GradientBoostingRegressor</span></code></a>. Both have similar options and
both have the parameter <code class="docutils literal notranslate"><span class="pre">loss</span></code>, which is especially useful in the regression
case as it enables the estimation of conditional mean as well as conditional
quantiles.</p>
<p>For linear models, there are many estimator classes which are very close to
each other. Let us have a look at</p>
<ul class="simple">
<li><p><a class="reference internal" href="modules/generated/sklearn.linear_model.LinearRegression.html#sklearn.linear_model.LinearRegression" title="sklearn.linear_model.LinearRegression"><code class="xref py py-class docutils literal notranslate"><span class="pre">LinearRegression</span></code></a>, no penalty</p></li>
<li><p><a class="reference internal" href="modules/generated/sklearn.linear_model.Ridge.html#sklearn.linear_model.Ridge" title="sklearn.linear_model.Ridge"><code class="xref py py-class docutils literal notranslate"><span class="pre">Ridge</span></code></a>, L2 penalty</p></li>
<li><p><a class="reference internal" href="modules/generated/sklearn.linear_model.Lasso.html#sklearn.linear_model.Lasso" title="sklearn.linear_model.Lasso"><code class="xref py py-class docutils literal notranslate"><span class="pre">Lasso</span></code></a>, L1 penalty (sparse models)</p></li>
<li><p><a class="reference internal" href="modules/generated/sklearn.linear_model.ElasticNet.html#sklearn.linear_model.ElasticNet" title="sklearn.linear_model.ElasticNet"><code class="xref py py-class docutils literal notranslate"><span class="pre">ElasticNet</span></code></a>, L1 + L2 penalty (less sparse models)</p></li>
<li><p><a class="reference internal" href="modules/generated/sklearn.linear_model.SGDRegressor.html#sklearn.linear_model.SGDRegressor" title="sklearn.linear_model.SGDRegressor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SGDRegressor</span></code></a> with <code class="docutils literal notranslate"><span class="pre">loss="squared_loss"</span></code></p></li>
</ul>
<p><strong>Maintainer perspective:</strong>
They all do in principle the same and are different only by the penalty they
impose. This, however, has a large impact on the way the underlying
optimization problem is solved. In the end, this amounts to usage of different
methods and tricks from linear algebra. A special case is
<a class="reference internal" href="modules/generated/sklearn.linear_model.SGDRegressor.html#sklearn.linear_model.SGDRegressor" title="sklearn.linear_model.SGDRegressor"><code class="xref py py-class docutils literal notranslate"><span class="pre">SGDRegressor</span></code></a> which
comprises all 4 previous models and is different by the optimization procedure.
A further side effect is that the different estimators favor different data
layouts (<code class="docutils literal notranslate"><span class="pre">X</span></code> C-contiguous or F-contiguous, sparse csr or csc). This complexity
of the seemingly simple linear models is the reason for having different
estimator classes for different penalties.</p>
<p><strong>User perspective:</strong>
First, the current design is inspired by the scientific literature where linear
regression models with different regularization/penalty were given different
names, e.g. <em>ridge regression</em>. Having different model classes with according
names makes it easier for users to find those regression models.
Secondly, if all the 5 above mentioned linear models were unified into a single
class, there would be parameters with a lot of options like the <code class="docutils literal notranslate"><span class="pre">solver</span></code>
parameter. On top of that, there would be a lot of exclusive interactions
between different parameters. For example, the possible options of the
parameters <code class="docutils literal notranslate"><span class="pre">solver</span></code>, <code class="docutils literal notranslate"><span class="pre">precompute</span></code> and <code class="docutils literal notranslate"><span class="pre">selection</span></code> would depend on the
chosen values of the penalty parameters <code class="docutils literal notranslate"><span class="pre">alpha</span></code> and <code class="docutils literal notranslate"><span class="pre">l1_ratio</span></code>.</p>
</section>
</section>
<section id="contributing">
<h2><a class="toc-backref" href="#id17" role="doc-backlink">Contributing</a><a class="headerlink" href="#contributing" title="Link to this heading">#</a></h2>
<section id="how-can-i-contribute-to-scikit-learn">
<h3><a class="toc-backref" href="#id18" role="doc-backlink">How can I contribute to scikit-learn?</a><a class="headerlink" href="#how-can-i-contribute-to-scikit-learn" title="Link to this heading">#</a></h3>
<p>See <a class="reference internal" href="developers/contributing.html#contributing"><span class="std std-ref">Contributing</span></a>. Before wanting to add a new algorithm, which is
usually a major and lengthy undertaking, it is recommended to start with
<a class="reference internal" href="developers/contributing.html#new-contributors"><span class="std std-ref">known issues</span></a>. Please do not contact the contributors
of scikit-learn directly regarding contributing to scikit-learn.</p>
</section>
<section id="why-is-my-pull-request-not-getting-any-attention">
<h3><a class="toc-backref" href="#id19" role="doc-backlink">Why is my pull request not getting any attention?</a><a class="headerlink" href="#why-is-my-pull-request-not-getting-any-attention" title="Link to this heading">#</a></h3>
<p>The scikit-learn review process takes a significant amount of time, and
contributors should not be discouraged by a lack of activity or review on
their pull request. We care a lot about getting things right
the first time, as maintenance and later change comes at a high cost.
We rarely release any “experimental” code, so all of our contributions
will be subject to high use immediately and should be of the highest
quality possible initially.</p>
<p>Beyond that, scikit-learn is limited in its reviewing bandwidth; many of the
reviewers and core developers are working on scikit-learn on their own time.
If a review of your pull request comes slowly, it is likely because the
reviewers are busy. We ask for your understanding and request that you
not close your pull request or discontinue your work solely because of
this reason.</p>
</section>
<section id="what-are-the-inclusion-criteria-for-new-algorithms">
<span id="new-algorithms-inclusion-criteria"></span><h3><a class="toc-backref" href="#id20" role="doc-backlink">What are the inclusion criteria for new algorithms?</a><a class="headerlink" href="#what-are-the-inclusion-criteria-for-new-algorithms" title="Link to this heading">#</a></h3>
<p>We only consider well-established algorithms for inclusion. A rule of thumb is
at least 3 years since publication, 200+ citations, and wide use and
usefulness. A technique that provides a clear-cut improvement (e.g. an
enhanced data structure or a more efficient approximation technique) on
a widely-used method will also be considered for inclusion.</p>
<p>From the algorithms or techniques that meet the above criteria, only those
which fit well within the current API of scikit-learn, that is a <code class="docutils literal notranslate"><span class="pre">fit</span></code>,
<code class="docutils literal notranslate"><span class="pre">predict/transform</span></code> interface and ordinarily having input/output that is a
numpy array or sparse matrix, are accepted.</p>
<p>The contributor should support the importance of the proposed addition with
research papers and/or implementations in other similar packages, demonstrate
its usefulness via common use-cases/applications and corroborate performance
improvements, if any, with benchmarks and/or plots. It is expected that the
proposed algorithm should outperform the methods that are already implemented
in scikit-learn at least in some areas.</p>
<p>Inclusion of a new algorithm speeding up an existing model is easier if:</p>
<ul class="simple">
<li><p>it does not introduce new hyper-parameters (as it makes the library
more future-proof),</p></li>
<li><p>it is easy to document clearly when the contribution improves the speed
and when it does not, for instance, “when <code class="docutils literal notranslate"><span class="pre">n_features</span> <span class="pre">>></span>
<span class="pre">n_samples</span></code>”,</p></li>
<li><p>benchmarks clearly show a speed up.</p></li>
</ul>
<p>Also, note that your implementation need not be in scikit-learn to be used
together with scikit-learn tools. You can implement your favorite algorithm
in a scikit-learn compatible way, upload it to GitHub and let us know. We
will be happy to list it under <a class="reference internal" href="related_projects.html#related-projects"><span class="std std-ref">Related Projects</span></a>. If you already have
a package on GitHub following the scikit-learn API, you may also be
interested to look at <a class="reference external" href="https://scikit-learn-contrib.github.io">scikit-learn-contrib</a>.</p>
</section>
<section id="why-are-you-so-selective-on-what-algorithms-you-include-in-scikit-learn">
<span id="selectiveness"></span><h3><a class="toc-backref" href="#id21" role="doc-backlink">Why are you so selective on what algorithms you include in scikit-learn?</a><a class="headerlink" href="#why-are-you-so-selective-on-what-algorithms-you-include-in-scikit-learn" title="Link to this heading">#</a></h3>
<p>Code comes with maintenance cost, and we need to balance the amount of
code we have with the size of the team (and add to this the fact that
complexity scales non linearly with the number of features).
The package relies on core developers using their free time to
fix bugs, maintain code and review contributions.
Any algorithm that is added needs future attention by the developers,
at which point the original author might long have lost interest.
See also <a class="reference internal" href="#new-algorithms-inclusion-criteria"><span class="std std-ref">What are the inclusion criteria for new algorithms?</span></a>. For a great read about
long-term maintenance issues in open-source software, look at
<a class="reference external" href="https://www.fordfoundation.org/media/2976/roads-and-bridges-the-unseen-labor-behind-our-digital-infrastructure.pdf#page=8">the Executive Summary of Roads and Bridges</a>.</p>
</section>
</section>
<section id="using-scikit-learn">
<h2><a class="toc-backref" href="#id22" role="doc-backlink">Using scikit-learn</a><a class="headerlink" href="#using-scikit-learn" title="Link to this heading">#</a></h2>
<section id="what-s-the-best-way-to-get-help-on-scikit-learn-usage">
<h3><a class="toc-backref" href="#id23" role="doc-backlink">What’s the best way to get help on scikit-learn usage?</a><a class="headerlink" href="#what-s-the-best-way-to-get-help-on-scikit-learn-usage" title="Link to this heading">#</a></h3>
<ul class="simple">
<li><p>General machine learning questions: use <a class="reference external" href="https://stats.stackexchange.com/">Cross Validated</a> with the <code class="docutils literal notranslate"><span class="pre">[machine-learning]</span></code> tag.</p></li>
<li><p>scikit-learn usage questions: use <a class="reference external" href="https://stackoverflow.com/questions/tagged/scikit-learn">Stack Overflow</a> with the
<code class="docutils literal notranslate"><span class="pre">[scikit-learn]</span></code> and <code class="docutils literal notranslate"><span class="pre">[python]</span></code> tags. You can alternatively use the <a class="reference external" href="https://mail.python.org/mailman/listinfo/scikit-learn">mailing list</a>.</p></li>
</ul>
<p>Please make sure to include a minimal reproduction code snippet (ideally shorter
than 10 lines) that highlights your problem on a toy dataset (for instance from
<a class="reference internal" href="api/sklearn.datasets.html#module-sklearn.datasets" title="sklearn.datasets"><code class="xref py py-mod docutils literal notranslate"><span class="pre">sklearn.datasets</span></code></a> or randomly generated with functions of <code class="docutils literal notranslate"><span class="pre">numpy.random</span></code> with
a fixed random seed). Please remove any line of code that is not necessary to
reproduce your problem.</p>
<p>The problem should be reproducible by simply copy-pasting your code snippet in a Python
shell with scikit-learn installed. Do not forget to include the import statements.
More guidance to write good reproduction code snippets can be found at:
<a class="reference external" href="https://stackoverflow.com/help/mcve">https://stackoverflow.com/help/mcve</a>.</p>
<p>If your problem raises an exception that you do not understand (even after googling it),
please make sure to include the full traceback that you obtain when running the
reproduction script.</p>
<p>For bug reports or feature requests, please make use of the
<a class="reference external" href="https://github.com/scikit-learn/scikit-learn/issues">issue tracker on GitHub</a>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Please do not email any authors directly to ask for assistance, report bugs,
or for any other issue related to scikit-learn.</p>
</div>
</section>
<section id="how-should-i-save-export-or-deploy-estimators-for-production">
<h3><a class="toc-backref" href="#id24" role="doc-backlink">How should I save, export or deploy estimators for production?</a><a class="headerlink" href="#how-should-i-save-export-or-deploy-estimators-for-production" title="Link to this heading">#</a></h3>
<p>See <a class="reference internal" href="model_persistence.html#model-persistence"><span class="std std-ref">Model persistence</span></a>.</p>
</section>