scikit-opls 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. scikit_opls-0.1.0/.gitignore +603 -0
  2. scikit_opls-0.1.0/CHANGES.md +189 -0
  3. scikit_opls-0.1.0/CITATION.cff +59 -0
  4. scikit_opls-0.1.0/LICENSE +21 -0
  5. scikit_opls-0.1.0/PKG-INFO +294 -0
  6. scikit_opls-0.1.0/README.md +257 -0
  7. scikit_opls-0.1.0/docs/api/o2pls.md +3 -0
  8. scikit_opls-0.1.0/docs/api/opls.md +3 -0
  9. scikit_opls-0.1.0/docs/api/opls_da.md +3 -0
  10. scikit_opls-0.1.0/docs/api/plotting.md +10 -0
  11. scikit_opls-0.1.0/docs/api/validation.md +7 -0
  12. scikit_opls-0.1.0/docs/changelog.md +1 -0
  13. scikit_opls-0.1.0/docs/citing.md +50 -0
  14. scikit_opls-0.1.0/docs/index.md +33 -0
  15. scikit_opls-0.1.0/docs/installation.md +22 -0
  16. scikit_opls-0.1.0/docs/quickstart.md +137 -0
  17. scikit_opls-0.1.0/pyproject.toml +149 -0
  18. scikit_opls-0.1.0/src/scikit_opls/__init__.py +22 -0
  19. scikit_opls-0.1.0/src/scikit_opls/_inspection.py +240 -0
  20. scikit_opls-0.1.0/src/scikit_opls/_o2pls.py +569 -0
  21. scikit_opls-0.1.0/src/scikit_opls/_o2pls_core.py +527 -0
  22. scikit_opls-0.1.0/src/scikit_opls/_opls.py +801 -0
  23. scikit_opls-0.1.0/src/scikit_opls/_opls_da.py +340 -0
  24. scikit_opls-0.1.0/src/scikit_opls/_orthogonal.py +283 -0
  25. scikit_opls-0.1.0/src/scikit_opls/_preprocessing.py +85 -0
  26. scikit_opls-0.1.0/src/scikit_opls/_utils.py +69 -0
  27. scikit_opls-0.1.0/src/scikit_opls/plotting.py +475 -0
  28. scikit_opls-0.1.0/src/scikit_opls/py.typed +1 -0
  29. scikit_opls-0.1.0/src/scikit_opls/validation.py +245 -0
  30. scikit_opls-0.1.0/src/scikit_opls/version.py +8 -0
  31. scikit_opls-0.1.0/tests/__init__.py +1 -0
  32. scikit_opls-0.1.0/tests/_data.py +37 -0
  33. scikit_opls-0.1.0/tests/test_diagnostics.py +350 -0
  34. scikit_opls-0.1.0/tests/test_estimator_compat.py +102 -0
  35. scikit_opls-0.1.0/tests/test_feature_names.py +73 -0
  36. scikit_opls-0.1.0/tests/test_inspection.py +299 -0
  37. scikit_opls-0.1.0/tests/test_o2pls.py +305 -0
  38. scikit_opls-0.1.0/tests/test_o2pls_core.py +379 -0
  39. scikit_opls-0.1.0/tests/test_opls.py +352 -0
  40. scikit_opls-0.1.0/tests/test_opls_coefficients.py +95 -0
  41. scikit_opls-0.1.0/tests/test_opls_da.py +161 -0
  42. scikit_opls-0.1.0/tests/test_optional_dependencies.py +38 -0
  43. scikit_opls-0.1.0/tests/test_orthogonal.py +386 -0
  44. scikit_opls-0.1.0/tests/test_plotting.py +454 -0
  45. scikit_opls-0.1.0/tests/test_preprocessing.py +174 -0
  46. scikit_opls-0.1.0/tests/test_validation.py +237 -0
  47. scikit_opls-0.1.0/tests/test_vip.py +185 -0
@@ -0,0 +1,603 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ # Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ # poetry.lock
109
+ # poetry.toml
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115
+ # pdm.lock
116
+ # pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # pixi
121
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122
+ # pixi.lock
123
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124
+ # in the .venv directory. It is recommended not to include this directory in version control.
125
+ .pixi
126
+
127
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128
+ __pypackages__/
129
+
130
+ # Celery stuff
131
+ celerybeat-schedule
132
+ celerybeat.pid
133
+
134
+ # Redis
135
+ *.rdb
136
+ *.aof
137
+ *.pid
138
+
139
+ # RabbitMQ
140
+ mnesia/
141
+ rabbitmq/
142
+ rabbitmq-data/
143
+
144
+ # ActiveMQ
145
+ activemq-data/
146
+
147
+ # SageMath parsed files
148
+ *.sage.py
149
+
150
+ # Environments
151
+ .env
152
+ .envrc
153
+ .venv
154
+ env/
155
+ venv/
156
+ ENV/
157
+ env.bak/
158
+ venv.bak/
159
+
160
+ # Spyder project settings
161
+ .spyderproject
162
+ .spyproject
163
+
164
+ # Rope project settings
165
+ .ropeproject
166
+
167
+ # zensical / mkdocs documentation build output
168
+ /site
169
+
170
+ # mypy
171
+ .mypy_cache/
172
+ .dmypy.json
173
+ dmypy.json
174
+
175
+ # Pyre type checker
176
+ .pyre/
177
+
178
+ # pytype static type analyzer
179
+ .pytype/
180
+
181
+ # Cython debug symbols
182
+ cython_debug/
183
+
184
+ # PyCharm
185
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
186
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
187
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
188
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
189
+ # .idea/
190
+
191
+ # Abstra
192
+ # Abstra is an AI-powered process automation framework.
193
+ # Ignore directories containing user credentials, local state, and settings.
194
+ # Learn more at https://abstra.io/docs
195
+ .abstra/
196
+
197
+ # Visual Studio Code
198
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
199
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
200
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
201
+ # you could uncomment the following to ignore the entire vscode folder
202
+ # .vscode/
203
+ # Temporary file for partial code execution
204
+ tempCodeRunnerFile.py
205
+
206
+ # Ruff stuff:
207
+ .ruff_cache/
208
+
209
+ # PyPI configuration file
210
+ .pypirc
211
+
212
+ # Marimo
213
+ marimo/_static/
214
+ marimo/_lsp/
215
+ __marimo__/
216
+
217
+ # Streamlit
218
+ .streamlit/secrets.toml
219
+
220
+ # scratch
221
+ scratch/
222
+ runs/
223
+ /data/
224
+ outputs/
225
+ src/modernmolbert/eval/junk/benchmarking_molecular_models_upstream
226
+ src/modernmolbert/eval/junk/
227
+ /*.tsv
228
+ /*.csv
229
+ /*.tar.gz
230
+
231
+ # AI
232
+ .github/prompts/
233
+ .github/copilot-instructions.md
234
+ .prompt.md
235
+ .agents/
236
+ /*.prompt.md
237
+ /*plan*.md
238
+ *repomix*.xml
239
+ CLAUDE.md
240
+ GEMINI.md
241
+ .claude/
242
+ .vscode/
243
+
244
+ # eval
245
+ tmp*/
246
+ tokenizer/tests
247
+ tokenizer/checkpoints
248
+
249
+
250
+ # Large files
251
+ src/modernmolbert/eval/benchmarking_molecular_models/results/arxiv_preprint_2025_08.csv
252
+
253
+ # Trained model artifacts
254
+ checkpoints/
255
+ models/
256
+ wandb/
257
+ *.safetensors
258
+ *.pt
259
+ *.pth
260
+
261
+ # LaTex
262
+
263
+ # TEMP main.pdf for now
264
+ paper/main.pdf
265
+ paper/papers/*
266
+ paper/notes/
267
+ paper/tables/*.docx
268
+ /plots/
269
+ !paper/figures/*
270
+
271
+ ## Core latex/pdflatex auxiliary files:
272
+ *.aux
273
+ *.lof
274
+ *.log
275
+ *.lot
276
+ *.fls
277
+ *.out
278
+ *.toc
279
+ *.fmt
280
+ *.fot
281
+ *.cb
282
+ *.cb2
283
+ .*.lb
284
+
285
+ ## Intermediate documents:
286
+ *.dvi
287
+ *.xdv
288
+ *-converted-to.*
289
+ # these rules might exclude image files for figures etc.
290
+ # *.ps
291
+ # *.eps
292
+ # *.pdf
293
+
294
+ ## Generated if empty string is given at "Please type another file name for output:"
295
+ .pdf
296
+
297
+ ## Bibliography auxiliary files (bibtex/biblatex/biber):
298
+ *.bbl
299
+ *.bbl-SAVE-ERROR
300
+ *.bcf
301
+ *.bcf-SAVE-ERROR
302
+ *.blg
303
+ *-blx.aux
304
+ *-blx.bib
305
+ *.run.xml
306
+
307
+ ## Build tool auxiliary files:
308
+ *.fdb_latexmk
309
+ *.synctex
310
+ *.synctex(busy)
311
+ *.synctex.gz
312
+ *.synctex.gz(busy)
313
+ *.pdfsync
314
+ *.rubbercache
315
+ rubber.cache
316
+
317
+ ## Build tool directories for auxiliary files
318
+ # latexrun
319
+ latex.out/
320
+
321
+ ## Auxiliary and intermediate files from other packages:
322
+ # algorithms
323
+ *.alg
324
+ *.loa
325
+
326
+ # achemso
327
+ acs-*.bib
328
+
329
+ # amsthm
330
+ *.thm
331
+
332
+ # attachfile2
333
+ *.atfi
334
+
335
+ # beamer
336
+ *.nav
337
+ *.pre
338
+ *.snm
339
+ *.vrb
340
+
341
+ # changes
342
+ *.soc
343
+ *.loc
344
+
345
+ # comment
346
+ *.cut
347
+
348
+ # context
349
+ *.tuc
350
+ *.tui
351
+ *.tuo
352
+
353
+ # cprotect
354
+ *.cpt
355
+
356
+ # elsarticle (documentclass of Elsevier journals)
357
+ *.spl
358
+
359
+ # endnotes
360
+ *.ent
361
+
362
+ # fixme
363
+ *.lox
364
+
365
+ # feynmf/feynmp
366
+ *.mf
367
+ *.mp
368
+ *.t[1-9]
369
+ *.t[1-9][0-9]
370
+ *.tfm
371
+
372
+ #(r)(e)ledmac/(r)(e)ledpar
373
+ *.end
374
+ *.?end
375
+ *.[1-9]
376
+ *.[1-9][0-9]
377
+ *.[1-9][0-9][0-9]
378
+ *.[1-9]R
379
+ *.[1-9][0-9]R
380
+ *.[1-9][0-9][0-9]R
381
+ *.eledsec[1-9]
382
+ *.eledsec[1-9]R
383
+ *.eledsec[1-9][0-9]
384
+ *.eledsec[1-9][0-9]R
385
+ *.eledsec[1-9][0-9][0-9]
386
+ *.eledsec[1-9][0-9][0-9]R
387
+
388
+ # glossaries
389
+ *.acn
390
+ *.acr
391
+ *.glg
392
+ *.glg-abr
393
+ *.glo
394
+ *.glo-abr
395
+ *.gls
396
+ *.gls-abr
397
+ *.glsdefs
398
+ *.lzo
399
+ *.lzs
400
+ *.slg
401
+ *.slo
402
+ *.sls
403
+
404
+ # uncomment this for glossaries-extra (will ignore makeindex's style files!)
405
+ # *.ist
406
+
407
+ # gnuplot
408
+ *.gnuplot
409
+ *.table
410
+
411
+ # gnuplottex
412
+ *-gnuplottex-*
413
+
414
+ # gregoriotex
415
+ *.gaux
416
+ *.glog
417
+ *.gtex
418
+
419
+ # htlatex
420
+ *.4ct
421
+ *.4tc
422
+ *.idv
423
+ *.lg
424
+ *.trc
425
+ *.xref
426
+
427
+ # hypdoc
428
+ *.hd
429
+
430
+ # hyperref
431
+ *.brf
432
+
433
+ # knitr
434
+ *-concordance.tex
435
+ # TODO Uncomment the next line if you use knitr and want to ignore its generated tikz files
436
+ # *.tikz
437
+ *-tikzDictionary
438
+
439
+ # latexindent will create succesive backup files by default
440
+ #*.bak*
441
+
442
+ # listings
443
+ *.lol
444
+
445
+ # luatexja-ruby
446
+ *.ltjruby
447
+
448
+ # makeidx
449
+ *.idx
450
+ *.ilg
451
+ *.ind
452
+
453
+ # minitoc
454
+ *.maf
455
+ *.mlf
456
+ *.mlt
457
+ *.mtc[0-9]*
458
+ *.slf[0-9]*
459
+ *.slt[0-9]*
460
+ *.stc[0-9]*
461
+
462
+ # minted
463
+ _minted*
464
+ *.data.minted
465
+ *.pyg
466
+
467
+ # morewrites
468
+ *.mw
469
+
470
+ # newpax
471
+ *.newpax
472
+
473
+ # nomencl
474
+ *.nlg
475
+ *.nlo
476
+ *.nls
477
+
478
+ # pax
479
+ *.pax
480
+
481
+ # pdfpcnotes
482
+ *.pdfpc
483
+
484
+ # sagetex
485
+ *.sagetex.sage
486
+ *.sagetex.py
487
+ *.sagetex.scmd
488
+
489
+ # scrwfile
490
+ *.wrt
491
+
492
+ # spelling
493
+ *.spell.bad
494
+ *.spell.txt
495
+
496
+ # svg
497
+ svg-inkscape/
498
+
499
+ # sympy
500
+ *.sout
501
+ *.sympy
502
+ sympy-plots-for-*.tex/
503
+
504
+ # pdfcomment
505
+ *.upa
506
+ *.upb
507
+
508
+ # pythontex
509
+ *.pytxcode
510
+ pythontex-files-*/
511
+
512
+ # tcolorbox
513
+ *.listing
514
+
515
+ # thmtools
516
+ *.loe
517
+
518
+ # TikZ & PGF
519
+ *.dpth
520
+ *.md5
521
+ *.auxlock
522
+
523
+ # titletoc
524
+ *.ptc
525
+
526
+ # todonotes
527
+ *.tdo
528
+
529
+ # vhistory
530
+ *.hst
531
+ *.ver
532
+
533
+ # easy-todo
534
+ *.lod
535
+
536
+ # xcolor
537
+ *.xcp
538
+
539
+ # xmpincl
540
+ *.xmpi
541
+
542
+ # xindy
543
+ *.xdy
544
+
545
+ # xypic precompiled matrices and outlines
546
+ *.xyc
547
+ *.xyd
548
+
549
+ # endfloat
550
+ *.ttt
551
+ *.fff
552
+
553
+ # Latexian
554
+ TSWLatexianTemp*
555
+
556
+ ## Editors:
557
+ # WinEdt
558
+ *.bak
559
+ *.sav
560
+
561
+ # latexindent.pl
562
+ *.bak[0-9]*
563
+
564
+ # Texpad
565
+ .texpadtmp
566
+
567
+ # LyX
568
+ *.lyx~
569
+
570
+ # Kile
571
+ *.backup
572
+
573
+ # gummi
574
+ .*.swp
575
+
576
+ # KBibTeX
577
+ *~[0-9]*
578
+
579
+ # TeXnicCenter
580
+ *.tps
581
+
582
+ # auto folder when using emacs and auctex
583
+ ./auto/*
584
+ *.el
585
+
586
+ # expex forward references with \gathertags
587
+ *-tags.tex
588
+
589
+ # standalone packages
590
+ *.sta
591
+
592
+ # Makeindex log files
593
+ *.lpz
594
+
595
+ # xwatermark package
596
+ *.xwm
597
+
598
+ # Mac
599
+ .DS_Store
600
+
601
+ # MkDocs build output
602
+ site/
603
+ scikit-learn-developers-guide.md