Lack of a user guide

[Baha]

Hello,

in the past weeks I've been watching closely this repository since I planned to make a course work based on Halide.

However, this has been really hard to do because there are no simple examples to get started, and the only way to learn is to infer something from the examples given (blur, local_laplacian, etc.).

I suggest you to write a user guide (you can expand your wiki), with examples about how to properly use Halide. You can start by explaining simple tasks (for example, rgb to grayscale) and maybe harder tasks (gaussian blur).

This way, you can get users for this software in a less painful way (for them). And these users can later become developers, who will take care of the software once you can't support or pay enough attention to it.

Best regards,

Baha

[abadams]

This is absolutely true. We've neglected it because we want the developer experience to be slightly better before we actively encourage people to use it, but it's time to do this. In the meantime we've been pointing people at the tests folder, which contains numerous small examples.

[Baha]

I think you already have a good piece of software. It can have some bugs here and there, but the top layer will remain the same, and meanwhile, you can work fixing the lower one if it is broken.

[cod3monk3y]

I'm also having a heck of a time finding structured documentation outside of the 4 simple tutorial cpp files. I'd like to explore image processing using Halide, but the documentation is severely lacking, unless I'm missing something.

[zvookin]

Have you looked at the Doxygen output here:
http://halide-lang.org/Halide/

-Z-

On Wed, Aug 14, 2013 at 6:27 PM, Eric Borts notifications@github.comwrote:

I'm also having a heck of a time finding structured documentation outside
of the 4 simple tutorial cpp files. I'd like to explore image processing
using Halide, but the documentation is severely lacking, unless I'm missing
something.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/87#issuecomment-22679788
.

[abadams]

For the benefit of people stumbling across this issue: The current docs url is
http://halide-lang.org/docs

We still need something more like a user guide though

[shrutisharmavsco]

As a beginner, I am having a hard time figuring out how to get started with writing Halide code. I am looking at the tutorials and test apps in this repo but they are not very straight forward for a complete newbie starting from scratch. Any suggestions?

[abadams]

This is intended to be the place to start:

http://halide-lang.org/tutorials/tutorial_lesson_01_basics.html

On Tue, Apr 26, 2016 at 4:53 PM, shrutisharmavsco notifications@github.com
wrote:

As a beginner, I am having a hard time figuring out how to get started
with writing Halide code. I am looking at the tutorials and test apps in
this repo but they are not very straight forward for a complete newbie
starting from scratch. Any suggestions?

—
You are receiving this because you commented.
Reply to this email directly or view it on GitHub
#87 (comment)

[kiranadam]

I heavily use OpenCV for my work of Image Processing and I've not seen image conversions for RGB to different color spaces (HSV, Lab etc) in Halide is there anything available of this sort?

[alexreinking]

A user guide is very likely to be a byproduct of my current formalization efforts. Please loop me in if you would like to work on this.