Re: [julia-users] Re: Googling the functions I need in Julia is hard

[Mauro]

Also at the Julia REPL:

julia> apropos("standard deviation")
randn!
stdm
std
randn

help?> std
search: std stdm STDIN STDOUT STDERR setdiff setdiff! hist2d hist2d! stride 
strides StridedArray StridedVector StridedMatrix StridedVecOrMat redirect_stdin

  std(v[, region])

  Compute the sample standard deviation of a vector or array v, optionally 
along dimensions in region. The algorithm returns an estimator of the generative
  distribution's standard deviation under the assumption that each entry of 
v is an IID drawn from that generative distribution. This computation is 
equivalent to
  calculating sqrt(sum((v - mean(v)).^2) / (length(v) - 1)). Note: Julia 
does not ignore NaN values in the computation. For applications requiring the 
handling of
  missing data, the DataArray package is recommended.

Having said this, documentation always needs improvements and is
certainly not on Matlab's level of completeness.  Please contribute
where you find it lacking.  See
https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#improving-documentation


On Fri, 2016-02-12 at 09:18, NotSoRecentConvert  wrote:
> You can even download the entire thing as a PDF, HTML, or EPUB if you want
> to highlight, annotate, or bookmark your most searched functions. Look in
> the lower right of the page for "v: latest" and click it for more options.
>
> On Friday, February 12, 2016 at 8:03:27 AM UTC+1, Lutfullah Tomak wrote:
>>
>> There is this one
>>
>> http://docs.julialang.org/en/release-0.4/stdlib/math/#Base.std
>>
>> Instead of google, I use this manual for search.
>>
>>

[julia-users] Re: Googling the functions I need in Julia is hard

[NotSoRecentConvert]

You can even download the entire thing as a PDF, HTML, or EPUB if you want 
to highlight, annotate, or bookmark your most searched functions. Look in 
the lower right of the page for "v: latest" and click it for more options.

On Friday, February 12, 2016 at 8:03:27 AM UTC+1, Lutfullah Tomak wrote:
>
> There is this one
>
> http://docs.julialang.org/en/release-0.4/stdlib/math/#Base.std
>
> Instead of google, I use this manual for search. 
>
>

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[Michele Zaffalon]

But the original point is still valid: using the search box in the official
documentation page http://docs.julialang.org/en/release-0.4, searching for
"standard deviation" does not bring up any useful hit, despite the fact
that Base.std is fairly well documented and contains the words standard
deviation.
Is there a reason why it should work at the REPL but not in the webpage?


On Fri, Feb 12, 2016 at 9:25 AM, Mauro  wrote:

> Also at the Julia REPL:
>
> julia> apropos("standard deviation")
> randn!
> stdm
> std
> randn
>
> help?> std
> search: std stdm STDIN STDOUT STDERR setdiff setdiff! hist2d hist2d!
> stride strides StridedArray StridedVector StridedMatrix StridedVecOrMat
> redirect_stdin
>
>   std(v[, region])
>
>   Compute the sample standard deviation of a vector or array v,
> optionally along dimensions in region. The algorithm returns an estimator
> of the generative
>   distribution's standard deviation under the assumption that each
> entry of v is an IID drawn from that generative distribution. This
> computation is equivalent to
>   calculating sqrt(sum((v - mean(v)).^2) / (length(v) - 1)). Note:
> Julia does not ignore NaN values in the computation. For applications
> requiring the handling of
>   missing data, the DataArray package is recommended.
>
> Having said this, documentation always needs improvements and is
> certainly not on Matlab's level of completeness.  Please contribute
> where you find it lacking.  See
>
> https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#improving-documentation
>
>
> On Fri, 2016-02-12 at 09:18, NotSoRecentConvert  wrote:
> > You can even download the entire thing as a PDF, HTML, or EPUB if you
> want
> > to highlight, annotate, or bookmark your most searched functions. Look in
> > the lower right of the page for "v: latest" and click it for more
> options.
> >
> > On Friday, February 12, 2016 at 8:03:27 AM UTC+1, Lutfullah Tomak wrote:
> >>
> >> There is this one
> >>
> >> http://docs.julialang.org/en/release-0.4/stdlib/math/#Base.std
> >>
> >> Instead of google, I use this manual for search.
> >>
> >>
>

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[Lutfullah Tomak]

Sorry deleted that post because that wasn't I used.

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[Milan Bouchet-Valat]

Le vendredi 12 février 2016 à 09:51 +0100, Michele Zaffalon a écrit :
> But the original point is still valid: using the search box in the
> official documentation page http://docs.julialang.org/en/release-0.4,
> searching for "standard deviation" does not bring up any useful hit,
> despite the fact that Base.std is fairly well documented and contains
> the words standard deviation.
> Is there a reason why it should work at the REPL but not in the
> webpage?
Searching for "deviation" works, so it's quite mysterious that
"standard deviation" doesn't... Looks like a bug in the Sphinx search
engine.

Google's behavior is really weird too. Even a query like "standard
deviation julia site:docs.julialang.org" gives the manual page home for
the standard library first (even if it doesn't contain "deviation"), as
well as pages mentioning "standard error". Maybe some pages are not
indexed at all? Could something be tweaked in the Sphinx configuration?


Regards

> 
> On Fri, Feb 12, 2016 at 9:25 AM, Mauro  wrote:
> > Also at the Julia REPL:
> > 
> >     julia> apropos("standard deviation")
> >     randn!
> >     stdm
> >     std
> >     randn
> > 
> >     help?> std
> >     search: std stdm STDIN STDOUT STDERR setdiff setdiff! hist2d
> > hist2d! stride strides StridedArray StridedVector StridedMatrix
> > StridedVecOrMat redirect_stdin
> > 
> >       std(v[, region])
> > 
> >       Compute the sample standard deviation of a vector or array v,
> > optionally along dimensions in region. The algorithm returns an
> > estimator of the generative
> >       distribution's standard deviation under the assumption that
> > each entry of v is an IID drawn from that generative distribution.
> > This computation is equivalent to
> >       calculating sqrt(sum((v - mean(v)).^2) / (length(v) - 1)).
> > Note: Julia does not ignore NaN values in the computation. For
> > applications requiring the handling of
> >       missing data, the DataArray package is recommended.
> > 
> > Having said this, documentation always needs improvements and is
> > certainly not on Matlab's level of completeness.  Please contribute
> > where you find it lacking.  See
> > https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#impr
> > oving-documentation
> > 
> > 
> > On Fri, 2016-02-12 at 09:18, NotSoRecentConvert 
> > wrote:
> > > You can even download the entire thing as a PDF, HTML, or EPUB if
> > you want
> > > to highlight, annotate, or bookmark your most searched functions.
> > Look in
> > > the lower right of the page for "v: latest" and click it for more
> > options.
> > >
> > > On Friday, February 12, 2016 at 8:03:27 AM UTC+1, Lutfullah Tomak
> > wrote:
> > >>
> > >> There is this one
> > >>
> > >> http://docs.julialang.org/en/release-0.4/stdlib/math/#Base.std
> > >>
> > >> Instead of google, I use this manual for search.
> > >>
> > >>
> > 

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[Milan Bouchet-Valat]

Le vendredi 12 février 2016 à 04:16 -0800, J Luis a écrit :
> One main 'dislike' I find in the documentation is that, contrary to
> Matlab and R examples that have one page for each function, in julia
> we have lots of functions per page with short and often cryptic
> descriptions. Example
> 
> std(v[, region])
> Compute the sample standard deviation of a vector or array v,
> optionally along dimensions in region.
> 
> To have longer and, VERY IMPORTANT, usage examples one need a per
> function page manual.
It's not that common for several Julia functions to be documented on
the same page. Actually, it's probably less common than in R (have a
look at ?grep or ?read.table). But indeed the docs could be expanded in
some cases. If you make pull requests adding examples (more precisely
doctests that are run and checked when building Julia), I'm sure they
will be welcome.


Regards

> sexta-feira, 12 de Fevereiro de 2016 às 11:10:54 UTC, Milan Bouchet-
> Valat escreveu:
> > Le vendredi 12 février 2016 à 09:51 +0100, Michele Zaffalon a
> > écrit : 
> > > But the original point is still valid: using the search box in
> > the 
> > > official documentation page http://docs.julialang.org/en/release-
> > 0.4, 
> > > searching for "standard deviation" does not bring up any useful
> > hit, 
> > > despite the fact that Base.std is fairly well documented and
> > contains 
> > > the words standard deviation. 
> > > Is there a reason why it should work at the REPL but not in the 
> > > webpage? 
> > Searching for "deviation" works, so it's quite mysterious that 
> > "standard deviation" doesn't... Looks like a bug in the Sphinx
> > search 
> > engine. 
> > 
> > Google's behavior is really weird too. Even a query like "standard 
> > deviation julia site:docs.julialang.org" gives the manual page home
> > for 
> > the standard library first (even if it doesn't contain
> > "deviation"), as 
> > well as pages mentioning "standard error". Maybe some pages are
> > not 
> > indexed at all? Could something be tweaked in the Sphinx
> > configuration? 
> > 
> > 
> > Regards 
> > 
> > > 
> > > On Fri, Feb 12, 2016 at 9:25 AM, Mauro 
> > wrote: 
> > > > Also at the Julia REPL: 
> > > > 
> > > >     julia> apropos("standard deviation") 
> > > >     randn! 
> > > >     stdm 
> > > >     std 
> > > >     randn 
> > > > 
> > > >     help?> std 
> > > >     search: std stdm STDIN STDOUT STDERR setdiff setdiff!
> > hist2d 
> > > > hist2d! stride strides StridedArray StridedVector
> > StridedMatrix 
> > > > StridedVecOrMat redirect_stdin 
> > > > 
> > > >       std(v[, region]) 
> > > > 
> > > >       Compute the sample standard deviation of a vector or
> > array v, 
> > > > optionally along dimensions in region. The algorithm returns
> > an 
> > > > estimator of the generative 
> > > >       distribution's standard deviation under the assumption
> > that 
> > > > each entry of v is an IID drawn from that generative
> > distribution. 
> > > > This computation is equivalent to 
> > > >       calculating sqrt(sum((v - mean(v)).^2) / (length(v) -
> > 1)). 
> > > > Note: Julia does not ignore NaN values in the computation. For 
> > > > applications requiring the handling of 
> > > >       missing data, the DataArray package is recommended. 
> > > > 
> > > > Having said this, documentation always needs improvements and
> > is 
> > > > certainly not on Matlab's level of completeness.  Please
> > contribute 
> > > > where you find it lacking.  See 
> > > > https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#
> > impr 
> > > > oving-documentation 
> > > > 
> > > > 
> > > > On Fri, 2016-02-12 at 09:18, NotSoRecentConvert  > om> 
> > > > wrote: 
> > > > > You can even download the entire thing as a PDF, HTML, or
> > EPUB if 
> > > > you want 
> > > > > to highlight, annotate, or bookmark your most searched
> > functions. 
> > > > Look in 
> > > > > the lower right of the page for "v: latest" and click it for
> > more 
> > > > options. 
> > > > > 
> > > > > On Friday, February 12, 2016 at 8:03:27 AM UTC+1, Lutfullah
> > Tomak 
> > > > wrote: 
> > > > >> 
> > > > >> There is this one 
> > > > >> 
> > > > >> http://docs.julialang.org/en/release-0.4/stdlib/math/#Base.s
> > td 
> > > > >> 
> > > > >> Instead of google, I use this manual for search. 
> > > > >> 
> > > > >> 
> > > > 

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[Michele Zaffalon]

On mine, it points to the functions randn and randn!

On Fri, Feb 12, 2016 at 11:48 AM, Lutfullah Tomak 
wrote:

> For reference, it shows up in my search.
>
>
> http://docs.julialang.org/en/release-0.4/search/?q=standard+deviation_keywords=yes=default
>
> About google side, I think that MATLAB and R are used for years and thus
> results are indexed better for them.

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[Lutfullah Tomak]

For reference, I had used just 'deviation'.

http://docs.julialang.org/en/release-0.4/search/?q=deviation_keywords=yes=default#

Another instance of 'standard deviation' shows up in the search but this one 
when 'standard deviation' is searched. 

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[Michael Borregaard]

Maybe a good time to repost this link: 
https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#improving-documentation
 


As I understand it, the julia documentation format is still an evolving 
entity. Google-searching in R works well because of the massive number of 
google searches / site visits to R pages. When I started using R, during my 
PhD in 2006, it was almost impossible to google R functions, and there were 
all kinds of (not very functional) search engines to bring up R results. 
Today everybody just googles it. I feel completely confident that julia 
will have the same development, and a lot faster.

Den fredag den 12. februar 2016 kl. 13.16.08 UTC+1 skrev J Luis:
>
> One main 'dislike' I find in the documentation is that, contrary to Matlab 
> and R examples that have one page for each function, in julia we have lots 
> of functions per page with short and often cryptic descriptions. Example
>
> std(*v*[, *region*])
>
> Compute the sample standard deviation of a vector or array v, optionally 
> along dimensions in region.
>
> To have longer and, VERY IMPORTANT, usage examples one need a per function 
> page manual.
>
> sexta-feira, 12 de Fevereiro de 2016 às 11:10:54 UTC, Milan Bouchet-Valat 
> escreveu:
>>
>> Le vendredi 12 février 2016 à 09:51 +0100, Michele Zaffalon a écrit : 
>> > But the original point is still valid: using the search box in the 
>> > official documentation page http://docs.julialang.org/en/release-0.4, 
>> > searching for "standard deviation" does not bring up any useful hit, 
>> > despite the fact that Base.std is fairly well documented and contains 
>> > the words standard deviation. 
>> > Is there a reason why it should work at the REPL but not in the 
>> > webpage? 
>> Searching for "deviation" works, so it's quite mysterious that 
>> "standard deviation" doesn't... Looks like a bug in the Sphinx search 
>> engine. 
>>
>> Google's behavior is really weird too. Even a query like "standard 
>> deviation julia site:docs.julialang.org" gives the manual page home for 
>> the standard library first (even if it doesn't contain "deviation"), as 
>> well as pages mentioning "standard error". Maybe some pages are not 
>> indexed at all? Could something be tweaked in the Sphinx configuration? 
>>
>>
>> Regards 
>>
>> > 
>> > On Fri, Feb 12, 2016 at 9:25 AM, Mauro  wrote: 
>> > > Also at the Julia REPL: 
>> > > 
>> > > julia> apropos("standard deviation") 
>> > > randn! 
>> > > stdm 
>> > > std 
>> > > randn 
>> > > 
>> > > help?> std 
>> > > search: std stdm STDIN STDOUT STDERR setdiff setdiff! hist2d 
>> > > hist2d! stride strides StridedArray StridedVector StridedMatrix 
>> > > StridedVecOrMat redirect_stdin 
>> > > 
>> > >   std(v[, region]) 
>> > > 
>> > >   Compute the sample standard deviation of a vector or array v, 
>> > > optionally along dimensions in region. The algorithm returns an 
>> > > estimator of the generative 
>> > >   distribution's standard deviation under the assumption that 
>> > > each entry of v is an IID drawn from that generative distribution. 
>> > > This computation is equivalent to 
>> > >   calculating sqrt(sum((v - mean(v)).^2) / (length(v) - 1)). 
>> > > Note: Julia does not ignore NaN values in the computation. For 
>> > > applications requiring the handling of 
>> > >   missing data, the DataArray package is recommended. 
>> > > 
>> > > Having said this, documentation always needs improvements and is 
>> > > certainly not on Matlab's level of completeness.  Please contribute 
>> > > where you find it lacking.  See 
>> > > https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#impr 
>> > > oving-documentation 
>> > > 
>> > > 
>> > > On Fri, 2016-02-12 at 09:18, NotSoRecentConvert  
>> > > wrote: 
>> > > > You can even download the entire thing as a PDF, HTML, or EPUB if 
>> > > you want 
>> > > > to highlight, annotate, or bookmark your most searched functions. 
>> > > Look in 
>> > > > the lower right of the page for "v: latest" and click it for more 
>> > > options. 
>> > > > 
>> > > > On Friday, February 12, 2016 at 8:03:27 AM UTC+1, Lutfullah Tomak 
>> > > wrote: 
>> > > >> 
>> > > >> There is this one 
>> > > >> 
>> > > >> http://docs.julialang.org/en/release-0.4/stdlib/math/#Base.std 
>> > > >> 
>> > > >> Instead of google, I use this manual for search. 
>> > > >> 
>> > > >> 
>> > > 
>>
>

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[J Luis]

One main 'dislike' I find in the documentation is that, contrary to Matlab 
and R examples that have one page for each function, in julia we have lots 
of functions per page with short and often cryptic descriptions. Example

std(*v*[, *region*])

Compute the sample standard deviation of a vector or array v, optionally 
along dimensions in region.

To have longer and, VERY IMPORTANT, usage examples one need a per function 
page manual.

sexta-feira, 12 de Fevereiro de 2016 às 11:10:54 UTC, Milan Bouchet-Valat 
escreveu:
>
> Le vendredi 12 février 2016 à 09:51 +0100, Michele Zaffalon a écrit : 
> > But the original point is still valid: using the search box in the 
> > official documentation page http://docs.julialang.org/en/release-0.4, 
> > searching for "standard deviation" does not bring up any useful hit, 
> > despite the fact that Base.std is fairly well documented and contains 
> > the words standard deviation. 
> > Is there a reason why it should work at the REPL but not in the 
> > webpage? 
> Searching for "deviation" works, so it's quite mysterious that 
> "standard deviation" doesn't... Looks like a bug in the Sphinx search 
> engine. 
>
> Google's behavior is really weird too. Even a query like "standard 
> deviation julia site:docs.julialang.org" gives the manual page home for 
> the standard library first (even if it doesn't contain "deviation"), as 
> well as pages mentioning "standard error". Maybe some pages are not 
> indexed at all? Could something be tweaked in the Sphinx configuration? 
>
>
> Regards 
>
> > 
> > On Fri, Feb 12, 2016 at 9:25 AM, Mauro  
> wrote: 
> > > Also at the Julia REPL: 
> > > 
> > > julia> apropos("standard deviation") 
> > > randn! 
> > > stdm 
> > > std 
> > > randn 
> > > 
> > > help?> std 
> > > search: std stdm STDIN STDOUT STDERR setdiff setdiff! hist2d 
> > > hist2d! stride strides StridedArray StridedVector StridedMatrix 
> > > StridedVecOrMat redirect_stdin 
> > > 
> > >   std(v[, region]) 
> > > 
> > >   Compute the sample standard deviation of a vector or array v, 
> > > optionally along dimensions in region. The algorithm returns an 
> > > estimator of the generative 
> > >   distribution's standard deviation under the assumption that 
> > > each entry of v is an IID drawn from that generative distribution. 
> > > This computation is equivalent to 
> > >   calculating sqrt(sum((v - mean(v)).^2) / (length(v) - 1)). 
> > > Note: Julia does not ignore NaN values in the computation. For 
> > > applications requiring the handling of 
> > >   missing data, the DataArray package is recommended. 
> > > 
> > > Having said this, documentation always needs improvements and is 
> > > certainly not on Matlab's level of completeness.  Please contribute 
> > > where you find it lacking.  See 
> > > https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#impr 
> > > oving-documentation 
> > > 
> > > 
> > > On Fri, 2016-02-12 at 09:18, NotSoRecentConvert  > 
> > > wrote: 
> > > > You can even download the entire thing as a PDF, HTML, or EPUB if 
> > > you want 
> > > > to highlight, annotate, or bookmark your most searched functions. 
> > > Look in 
> > > > the lower right of the page for "v: latest" and click it for more 
> > > options. 
> > > > 
> > > > On Friday, February 12, 2016 at 8:03:27 AM UTC+1, Lutfullah Tomak 
> > > wrote: 
> > > >> 
> > > >> There is this one 
> > > >> 
> > > >> http://docs.julialang.org/en/release-0.4/stdlib/math/#Base.std 
> > > >> 
> > > >> Instead of google, I use this manual for search. 
> > > >> 
> > > >> 
> > > 
>

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[Lutfullah Tomak]

For reference, it shows up in my search.

http://docs.julialang.org/en/release-0.4/search/?q=standard+deviation_keywords=yes=default

About google side, I think that MATLAB and R are used for years and thus 
results are indexed better for them.

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[NotSoRecentConvert]

That's similar to how I learned Matlab programming. They had similar 
functions listed at the bottom of each function page. Add in the forums and 
reverse engineering other peoples' code and you have the majority of Matlab 
learning experience. 

Re: [julia-users] Re: Googling the functions I need in Julia is hard

[Po Choi]

Good point. I tried to use this search box in Juila manual, but get nothing.
In R and Matlab, the search would return the function sd/std.

I think, not only the "words" in Julia documentation is needed to improved, 
but also the search engine.

On Friday, February 12, 2016 at 12:52:19 AM UTC-8, Michele Zaffalon wrote:
>
> But the original point is still valid: using the search box in the 
> official documentation page http://docs.julialang.org/en/release-0.4, 
> searching for "standard deviation" does not bring up any useful hit, 
> despite the fact that Base.std is fairly well documented and contains the 
> words standard deviation.
> Is there a reason why it should work at the REPL but not in the webpage?
>
>
> On Fri, Feb 12, 2016 at 9:25 AM, Mauro  
> wrote:
>
>> Also at the Julia REPL:
>>
>> julia> apropos("standard deviation")
>> randn!
>> stdm
>> std
>> randn
>>
>> help?> std
>> search: std stdm STDIN STDOUT STDERR setdiff setdiff! hist2d hist2d! 
>> stride strides StridedArray StridedVector StridedMatrix StridedVecOrMat 
>> redirect_stdin
>>
>>   std(v[, region])
>>
>>   Compute the sample standard deviation of a vector or array v, 
>> optionally along dimensions in region. The algorithm returns an estimator 
>> of the generative
>>   distribution's standard deviation under the assumption that each 
>> entry of v is an IID drawn from that generative distribution. This 
>> computation is equivalent to
>>   calculating sqrt(sum((v - mean(v)).^2) / (length(v) - 1)). Note: 
>> Julia does not ignore NaN values in the computation. For applications 
>> requiring the handling of
>>   missing data, the DataArray package is recommended.
>>
>> Having said this, documentation always needs improvements and is
>> certainly not on Matlab's level of completeness.  Please contribute
>> where you find it lacking.  See
>>
>> https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md#improving-documentation
>>
>>
>> On Fri, 2016-02-12 at 09:18, NotSoRecentConvert > > wrote:
>> > You can even download the entire thing as a PDF, HTML, or EPUB if you 
>> want
>> > to highlight, annotate, or bookmark your most searched functions. Look 
>> in
>> > the lower right of the page for "v: latest" and click it for more 
>> options.
>> >
>> > On Friday, February 12, 2016 at 8:03:27 AM UTC+1, Lutfullah Tomak wrote:
>> >>
>> >> There is this one
>> >>
>> >> http://docs.julialang.org/en/release-0.4/stdlib/math/#Base.std
>> >>
>> >> Instead of google, I use this manual for search.
>> >>
>> >>
>>
>
>