search

Sm00thix / IKPLS

Fast CPU and GPU Python implementations of Improved Kernel PLS by Dayal and MacGregor (1997) and Shortcutting Cross-Validation by Engstrøm (2024).
https://ikpls.readthedocs.io/en/latest/
Apache License 2.0
8 stars 3 forks source link

fix readme for broken references #19

Closed parmentelat closed 4 months ago

parmentelat commented 4 months ago

this should fix the text last reference 7. as well as, hopefully, the broken links towards #references in the context of pypi as well, although I can't test that

parmentelat commented 4 months ago

this is related to #10

Sm00thix commented 4 months ago

It did make the math symbols in [7] render correctly on readthedocs, which is nice! :)

Sm00thix commented 4 months ago

I made an update related to #15 which in turn pushed the changes to PyPI so that your PR is also visible on PyPI. Here, the same issue with (references)= being visible is also present. PyPI. The broken references are still broken, however.

parmentelat commented 4 months ago

hi so as you gathered the (references)= thingy is a pure MyST anchor syntax to explicitly set a references, as opposed to the implicit references that come with titles and subtitles however in the many contexts that do not speak MyST but rather regular markdown - typically PyPI and github - it appears that this is not recognized and so shows up as-is

so, clearly that is not the way to go, we need to remove it as it is more harmful than helpful

imho if the only caveat is that the links to the references section does not work in PyPI, this is totally good enough, no ?

Sm00thix commented 4 months ago

Hi @parmentelat ,

I agree with your rationale. I have removed the (references)= and bumped the version number to trigger an update on PyPI in addition to GitHub and Readthedocs. The tests usually take ~40 minutes to finish on GitHub actions. So we should be able to verify it by then.

Sm00thix commented 4 months ago

I had a bunch of issues as it seems that GitHub actions has removed support for the specific combination of Python3.9 and macos-latest running on an Arm processor. I tried using x64 instead for this specific combination, but that also appeared faulty. So I temporarily removed this specific combination from the test suite. The latest commit should resolve this and we should be able to see the changes on PyPI in ~40 minutes.