nmatrix icon indicating copy to clipboard operation
nmatrix copied to clipboard

merging tutorials in the wiki

Open cedlemo opened this issue 9 years ago • 4 comments

While I was reading the tutorials in your wiki, it appears that someone want to merge 3 of them: https://github.com/SciRuby/nmatrix/wiki/How-to-create-an-NMatrix https://github.com/SciRuby/nmatrix/wiki/Getting-started in https://github.com/SciRuby/nmatrix/wiki/Tentative-NMatrix-Tutorial

The tentative-NMatrix-Tutorial table of content is the following:

  • Tentative NMatrix Tutorial
    • Introduction
      • Credit & Disclaimer
      • Prerequisites
      • Rules for editing
    • The basics
      • An example
      • NMatrix creation
      • Printing Arrays
      • Basic Operations
      • Universal Methods

--(the following parts are not done yet)--

  • Indexing, Slicing and Iterating
    • Shape Manipulation
      • Changing the shape of an array
      • Stacking together different arrays
      • Splitting one array into several smaller ones
    • Copies and Views
      • No Copy at All
      • View or Shallow Copy
      • Deep Copy
      • Functions and Methods Overview
    • Less Basic
    • Broadcasting rules
    • Fancy indexing and index tricks
      • Indexing with Arrays of Indices
      • Indexing with Boolean Arrays
      • The ix_() function
      • Indexing with strings
    • Linear Algebra
      • Simple Array Operations
    • Tricks and Tips
      • “Automatic” Reshaping
      • Vector Stacking
      • Histograms
    • Further reading

Here is what I propose for the others wiki page (based on the existing page):

Getting-Started page:

  • Installation -->remove
  • Features (types of storage, API) -->remove
  • Differences from other matrix libraries -->remove
  • Brief Tutorial
    • ~~Creating matrices --> merge in "NMatrix creation"~~
    • ~~Simpler constructor for matrices --> merge in "NMatrix creation"~~
    • ~~One-dimensional matrices -->merge in "NMatrix creation"~~
    • ~~Matrix functions and operations --> merge in "Basic Operations"~~
    • Shortcuts --> merge in "NMatric creation" and "Indexing, Slicing ..."
    • Solving Linear systems -->remove
    • Matrix decomposition -->remove ?
    • Advanced features --> merge in "The basics" ?
      • additional data types
      • storage types

How to create an NMatrix page:

  • Introduction -->remove
  • the type of a matrix's elements (dtype)--> merge in "The basics" ?
  • the storage of a matrix--> merge in "The basics" ?
    • conclusion -->remove

I think that the "tentative-NMatrix-Tutorial" should be renamed to "Quickstart tutorial" like with numy. I think that the dtype and stype should be introduced in a separate wiki page which will be referenced in the "The Basics" part.

Please tell me if you are OK with this (or not).

cedlemo avatar Jul 09 '16 13:07 cedlemo

@v0dro What are your thoughts?

translunar avatar Jul 18 '16 19:07 translunar

@cedlemo Well, @v0dro hasn't replied. I'd say go for it. Thanks for offering!

translunar avatar Jul 25 '16 14:07 translunar

I'd say go for it

Ok

cedlemo avatar Jul 25 '16 17:07 cedlemo

Sorry missed this. Yes sounds good.

v0dro avatar Jul 25 '16 19:07 v0dro