Idea:- Add images/something_else across all functions in the data_block api, that shows the possible ways of how to use that function.
An example of what I am thinking. Consider
split_from_df function, I am thinking about adding some visual context or some text that specifically shows how this function can be used.
Why:- By discussing all the functions separately, I think more information can be conveyed about when we can use data_block build in functions. And it would also provide a common place where one can look for what he is doing wrong in his own code when using the data_block api.
How:- Initially, I was thinking about doing this by adding inline code. Next, I thought about adding the required output (like dataframe image) and adding some arrow key explanation on why this function is working or just some text around the corner for easy visual context.
Any suggestion on this approach. I think I can work out most of the stuff in 2-3 days, so should I work on this. @sgugger
Below are the screenshots of the rendered version of the docs for the required function. [CHANGES] refers to the changes in the docs section I am proposing for that section.
[CHANGES] -> Added one line explaining path and added image
[CHANGES] -> Added text. It explains how from_df can be used in any general situation and give an example explaining how to set the paths.
[CHANGES] -> No changes as it is same as
[CHANGES] -> Added a cifar-10 dummy example, on how to use the function
[CHANGES] -> Added, Internally makes a call to
fnamecontains your image file names like 0001.png.
[CHANGES] -> Added an example showing usage
[CHANGES] -> Referring to this issue. I think it was confusing to use this function, as it is used mostly as an internal function. So added a line telling this.
[CHANGES] -> Added example showing usage