search

stas00 / ml-engineering

Machine Learning Engineering Open Book
https://stasosphere.com/machine-learning/
Creative Commons Attribution Share Alike 4.0 International
11.55k stars 703 forks source link

Improve folder structure #15

Closed heyimjonas closed 8 months ago

heyimjonas commented 11 months ago

Would it be possible to improve the folder structure so it somewhat matches your table of contents?

eg: ├── Part 1 │ ├── Topic 1 │ ├── Topic 2 ├── Part 2 │ ├── Topic 3 │ ├── Topic 4

stas00 commented 11 months ago

It's a good suggestion, Jonas and I agree that this would be nice.

The structure is still emerging and changes every month or so, e.g. I'm not sure if each component should have its own performance and debug sub-sections, or whether it's better to have them grouped together like it is done now.

Unfortunately, most of the time github doesn't redirect when files are moved and provides no equivalent of .htaccess files to let users manage redirects, so I don't want to have too many broken links at this stage and am using a flat structure for now.

Eventually it will be awesome and intuitive and easy to navigate.

heyimjonas commented 11 months ago

Yeah that is reasonable, rewriting all the links etc. every month is not really worth it if it's gonna change again

Hope you'll keep it in mind for when it's more finalized :)

I'll patiently wait and read your content till then.

stas00 commented 8 months ago

I finally had the time to do a massive re-org in https://github.com/stas00/ml-engineering/pull/25

Hopefully it's much easier to read now.

And of course I will continue improving the layout.