BiomedSciAI / fuse-med-ml

A python framework accelerating ML based discovery in the medical field by encouraging code reuse. Batteries included :)
Apache License 2.0
134 stars 34 forks source link

create documentation project on Read the Docs #189

Open SagiPolaczek opened 1 year ago

SagiPolaczek commented 1 year ago

Hey! This issue aims to added documentation for FuseMedML using Read the Docs automating building.

Currently we have this, which is clearly irrelevant. The end goal is to have Fuse's documentation nicely documented on Read the Docs to help AI researchers get started with our tools. Please visit here for a good example.

Also note that the badge Documentation Status should be 'passing'.

References See casualib library and their read the docs. Read the Docs website



Please feel free to participate and solve that issue. Happy Coding !

Sai-Suraj-27 commented 1 year ago

Hi, @SagiPolaczek Can I work on this issue?

SagiPolaczek commented 1 year ago

Hey @Sai-Suraj-27 , Yes that will be great!

rakesh9177 commented 9 months ago

Hi @SagiPolaczek , Is this issue still open? If you would like, I can create a pull request by tomorrow for documentation. I already did complete most of it- https://fuseml.readthedocs.io/en/latest/index.html

SagiPolaczek commented 9 months ago

@rakesh9177 Yes it is. A PR will be great 😄

rakesh9177 commented 9 months ago

Hi @SagiPolaczek , I created a PR, please review and let me know if it is good or need any changes

PR - https://github.com/BiomedSciAI/fuse-med-ml/pull/339

SagiPolaczek commented 8 months ago

The badge that induced by your changes: 😄 Documentation Status

hichem-18 commented 2 weeks ago

Hi is this issue still available?