UBC-MDS / fixml

LLM Tool for effective test evaluation of ML projects with curated Checklists and LLM prompts
https://ubc-mds.github.io/fixml
Other
3 stars 2 forks source link

docs: Provide better instructional materials #208

Closed SoloSynth1 closed 4 months ago

SoloSynth1 commented 4 months ago

This PR:

Closes #205.

SoloSynth1 commented 4 months ago

Marking this PR as ready for review.

@jinyz8888 @tonyshumlh @JohnShiuMK Please note that some links in README.md does not work yet as the ReadtheDocs page has not been rendered. I have tested locally and the links should work once this PR is merged into main triggering RTD's rendering action on latest.

tonyshumlh commented 4 months ago

@SoloSynth1 i tried to run through every command in README and most things are fine, except the export of Evaluation Report that has error in lacking package tabulate. (shown below). Can we include it in our Poetry pyproject.toml, e.g. tabulate = "^0.9.0"?

Screenshot 2024-06-26 at 12 11 12 PM
SoloSynth1 commented 4 months ago

@SoloSynth1 i tried to run through every command in README and most things are fine, except the export of Evaluation Report that has error in lacking package tabulate. (shown below).

Can we include it in our Poetry pyproject.toml, e.g. tabulate = "^0.9.0"?

Screenshot 2024-06-26 at 12 11 12 PM

What's your export target format? Is it HTML?

SoloSynth1 commented 4 months ago

Also if possible, would you mind to paste the whole error stack?

JohnShiuMK commented 4 months ago

Also if possible, would you mind to paste the whole error stack?

Screenshot 2024-06-26 at 12 58 02 PM Screenshot 2024-06-26 at 12 58 10 PM Screenshot 2024-06-26 at 12 58 19 PM Screenshot 2024-06-26 at 12 58 28 PM
JohnShiuMK commented 4 months ago

I think adding tabulate = "^0.9.0" under [tool.poetry.dependencies] in pyproject.toml will quickly solve the problem

JohnShiuMK commented 4 months ago

in the README acknowledgement: Dr. Simon Goringfor

SoloSynth1 commented 4 months ago

Also if possible, would you mind to paste the whole error stack?

Screenshot 2024-06-26 at 12 58 02 PM Screenshot 2024-06-26 at 12 58 10 PM Screenshot 2024-06-26 at 12 58 19 PM Screenshot 2024-06-26 at 12 58 28 PM

Will try to reproduce this in my environments once I get back to campus

SoloSynth1 commented 4 months ago

in the README acknowledgement: Dr. Simon Goringfor

Fixed