search

scikit-adaptation / skada

Domain adaptation toolbox compatible with scikit-learn and pytorch
https://scikit-adaptation.github.io/
BSD 3-Clause "New" or "Revised" License
56 stars 16 forks source link

[MRG] Change readme and reorganize documentation #97

Closed rflamary closed 5 months ago

rflamary commented 5 months ago

This PR aim at having a more general readme file with a list of implemented methods but also with corresponding references. All the detailed discussion about how to use skada have been moved to the quickstart guide (but we will keep some simple example in the readme).

I'm merging this quickly so that we can improve on the doc ASAP.

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (0ddf351) 88.99% compared to head (bab72ba) 88.99%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #97 +/- ## ======================================= Coverage 88.99% 88.99% ======================================= Files 41 41 Lines 2708 2708 ======================================= Hits 2410 2410 Misses 298 298 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.