systemml-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Madison Myers <madisonjmy...@gmail.com>
Subject Re: Documentation Personas
Date Fri, 30 Sep 2016 22:41:01 GMT
Here are some ideas from a brainstorming session Jeremy, Rose, Renee and I
had on how to move forward with the website. Comments and opinions would be
great! (PDF of the same is attached)

*MJM Website Phase 2 Notes:*

*My Suggestions:*

*  1. Tutorials*

* 1.*Ideas: Literally how you download and start using all recommended
platforms; Jupyter notebooks walking through how to download data,
matrices, statistics, suggested algorithms, how to write own algorithms.

          2. Make brew install apache systemml known

   1. *Clarity*
      1. Documentation
         1. Perhaps this should be renamed? Documentation could be used
         within a section that is titled Get Started or Use SystemML etc.
         2. Tutorials could have their home here. Could acknowledge
         beginner or advanced?
         3. When click on Documentation, new links are “Overview” (which is
         documentation landing page and semi unnecessary and/or in the
wrong spot),
         Github and Documentation with a drop down. Let’s reorganize this.
      2. Join dev mailing list (make a note that it tries to be open and
      communication about work on SystemML is available there if one would like
      to add)
   2. *Flow of website*
      1. Consistency (Documentation goes to a different place that is
      inconsistent with the landing page)
      2. ease of use/clear how to get started
   3. *Deron’s requests*
      1. copy of the website (public github repo and deployed website are
      not in sync; Deron wants to make sure he is using the latest
work from the
      designers.)
      2. Find out which javascript libraries are being used by the new
      design (needs to include it in the LICENSE)
         1. will be public when finished
      4. *Niketan’s requests*
      1. Format contribute to systemml issue tracker to personas?
      2. Hackathon participants or developers who want to contribute to
      SystemML
      https://issues.apache.org/jira/browse/SYSTEMML-990?jql=project%20%3D%20SYSTEMML%20AND%20labels%20%3D%20starter
      3. External researchers who want to contribute to SystemML
      https://issues.apache.org/jira/browse/SYSTEMML-540,
      https://issues.apache.org/jira/browse/SYSTEMML-445,
      https://issues.apache.org/jira/browse/SYSTEMML-449 and
      https://issues.apache.org/jira/browse/SYSTEMML-451
      4. Data Scientists who want to implement new algorithms
      https://issues.apache.org/jira/browse/SYSTEMML-629?jql=project%20%3D%20SYSTEMML%20AND%20resolution%20%3D%20Unresolved%20AND%20component%20%3D%20Algorithms%20ORDER%20BY%20priority%20DESC
      5. Continue to have a place for users who found bugs or want to
      report usability concerns
   5. *Others’ requests*
      1. separate .11 from .10 (separate APIs) in documentation
      2. Education section (Arvind)
   6. *Longterm:*
      1. New logo
      2. New videos (Apache community, Apache SystemML + other ideas)
      3. Showcase where we are presenting (spark summit, UC Berkeley, etc.)
      4. Interactive video tutorials?
      5. Develop more use cases
      6. Community outreach ideas
         1. Hackathon
         2. Universities
         3. Meet-ups
         4. Blog continuation
         5. Conferences


*Brainstorming Sep 30, 2016:*

Suggested Plan:

1.Defining clear user flow

2.Making mailing list easy

3. Can’t help with code documentation, but can work with developer to help
organize documentation

4.Get started for first time users

5.Sample tutorials for first time users

6. Example notebooks that won’t break SystemML that people can use and
follow-along (clear documentation and

    explanation).

6. Use cases/samples for business people etc. that are interested

7. Place on website for where SystemML will be talked about (conferences,
summits, etc.)


Suggested Long-term Adoption Strategy:

1. Get SystemML ready to be used in universities (have Data Scientists
adopt early)

2. Get more involved in meet-ups

3. Continue to advertise where SystemML will be talked about

4. Continue developing social media on SystemML

5. Make Breast Cancer Project an example (when can we make that available?)


Question: Can we promote real use cases on the website?

On Fri, Sep 30, 2016 at 9:05 AM, Madison Myers <madisonjmyers@gmail.com>
wrote:

>
>
>
>
>
>
> *Although these types of meetings exclude the community, I believe
> theymight still bring value, but I would recommend two things :- Get all
> the participants to subscribe to the mailing list- After the meeting,
> please provide a summary with the main ideas andfinish the discussion
> around agreement on the next steps here on themailing list (Apache has a
> say that, if it didn't happen on the mailinglist, it didn't happen.)*
>
> I am sorry that you feel that this meeting excludes the community. I
> actually am surprised as I have been a big advocate of communication since
> the beginning! I actually dm'd you the other day asking to be looped in as
> several things have been changed on the website without notifying the team
> who is designated to work on it.
>
> Moreover, not sure if you know, but the design team actually interviewed
> several people from the SystemML team in an effort to better understand
> their work flow, needs, etc. and that is what we are coming together to
> discuss. Therefore I don't think it excludes anyone at all.
>
> I've been trying to get on the dev list for some time, but because there
> was some confusion, I was not able to communicate on here until this time.
> From here on out, as I said in the other thread, I will be updating
> everyone on everything.
>
> With all that being said, I am happy you value communication as much as me
> and we can work together to make sure everyone is on the same page and has
> a voice.
>
>
>
>
>
>
>
>
>
> *If a helloworld is not basic enough, maybe we need to identify what
> iswrong with the usability of SystemML. Let's give an example of a
> productthat I worked in the past, we were building a getting started guide
> usingeclipse, and we identified that there were multiple steps that were
> varyhard and required folks to have a deep technical understanding of
> theinternal of the product to be able to add the required dependencies
> andother steps, with the problem identified, we built an eclipse plugin
> thatsolved much of the issues. See the guide as an example here
> :http://tuscany.apache.org/getting-started-with-tuscany-using-tuscany-eclipse-plugin.html
> <http://tuscany.apache.org/getting-started-with-tuscany-using-tuscany-eclipse-plugin.html>*
>
> I think both. You are completely right. SystemML does need to be worked on
> to be more user friendly! I also think a very basic "this is how you
> literally download systemml and start it" is needed in addition to other
> tutorials such as the Jupyter notebooks (they can walk people through
> uploading data, matrices, algorithms, etc.).
>
>
>
>
>
>
> *+1, Notebooks seems to be a simple way to interact with code and a UI
> thata lot of data scientists would be familiar with.If we have a detailed
> guide (a.k.a. Tutorial) that explained how to addsystemml dependency, write
> a matrix multiplication, and execute... thiscould be a "helloworld" that
> people could easily understand, no ?*
>
> See above! I totally get where you're coming from, but I encourage us to
> have both. Coming from the perspective of a new data scientist (and having
> asked my peers to try SystemML) the overwhelming feedback is that people
> don't know how to use it and that they would like more tutorials that are
> clear and easy to follow.
>
> Thanks so much for taking the time to give your input! Really appreciate
> it. Will update you after the meeting.
>
> On Thu, Sep 29, 2016 at 11:12 PM, Luciano Resende <luckbr1975@gmail.com>
> wrote:
>
>> On Thu, Sep 29, 2016 at 8:10 PM, Madison Myers <madisonjmyers@gmail.com>
>> wrote:
>>
>> > Thanks for your input!
>> >
>> > I have an all day meeting/brainstorm session with the design team
>> tomorrow
>> > so this is super helpful. I totally agree with Mike that the personas
>> > should not be directly addressed, but rather opportunities for different
>> > personas/levels to interact with SystemML are available on the website
>> for
>> > the different user personas to navigate.
>> >
>> >
>> Although these types of meetings exclude the community, I believe they
>> might still bring value, but I would recommend two things :
>> - Get all the participants to subscribe to the mailing list
>> - After the meeting, please provide a summary with the main ideas and
>> finish the discussion around agreement on the next steps here on the
>> mailing list (Apache has a say that, if it didn't happen on the mailing
>> list, it didn't happen.)
>>
>> I think starting out, we are going to address the main issue: converting
>> > new users to SystemML. Unfortunately even just a how to write your
>> > algorithms is not a basic enough "hello world" if we want data
>> scientists
>> > to start using SystemML- especially those in school. Because more
>> advanced
>> > users can navigate the current documentation a little easier, we will
>> focus
>> > on that later, though it remains a priority.
>> >
>> >
>> If a helloworld is not basic enough, maybe we need to identify what is
>> wrong with the usability of SystemML. Let's give an example of a product
>> that I worked in the past, we were building a getting started guide using
>> eclipse, and we identified that there were multiple steps that were vary
>> hard and required folks to have a deep technical understanding of the
>> internal of the product to be able to add the required dependencies and
>> other steps, with the problem identified, we built an eclipse plugin that
>> solved much of the issues. See the guide as an example here :
>> http://tuscany.apache.org/getting-started-with-tuscany-using
>> -tuscany-eclipse-plugin.html
>> .
>>
>>
>>
>> > I can give you an update after the meeting tomorrow, but for now, we
>> > generally spoke about making tutorials and documentation clearer and
>> even
>> > potentially having links to Jupyter notebooks where users could follow
>> > along. We will also be focusing on the website flow so that people don't
>> > get lost while navigating and so that selections are more intuitive.
>> >
>> >
>> +1, Notebooks seems to be a simple way to interact with code and a UI that
>> a lot of data scientists would be familiar with.
>>
>> If we have a detailed guide (a.k.a. Tutorial) that explained how to add
>> systemml dependency, write a matrix multiplication, and execute... this
>> could be a "helloworld" that people could easily understand, no ?
>>
>>
>> > If you have any tutorials that are not already on the website, please
>> send
>> > them my way! We want to compile everything in order to have it all in
>> one
>> > place (and more organized!).
>> >
>>
>> +1
>>
>>
>> >
>> > Thanks!
>> >
>> > On Thu, Sep 29, 2016 at 5:51 PM, <dusenberrymw@gmail.com> wrote:
>> >
>> > > These topics and the idea of the personas are great!  I would suggest
>> > that
>> > > we don't explicitly use the specific persona titles though. I.e.
>> Instead
>> > of
>> > > specifically using "data scientists" we could just use "machine
>> learning"
>> > > such as "Getting started guide to machine learning with SystemML".
>> > Likewise
>> > > the topics for "data engineers" could instead be something like
>> "Getting
>> > > started guide to engine development". We could also have a
>> "deployment"
>> > > guide, etc.  In each we could also have beginner and expert sections.
>> > >
>> > > --
>> > >
>> > > Mike Dusenberry
>> > > GitHub: github.com/dusenberrymw
>> > > LinkedIn: linkedin.com/in/mikedusenberry
>> > >
>> > > Sent from my iPhone.
>> > >
>> > >
>> > > > On Sep 29, 2016, at 4:07 PM, Luciano Resende <luckbr1975@gmail.com>
>> > > wrote:
>> > > >
>> > > > On Wed, Sep 28, 2016 at 6:06 PM, Madison Myers <
>> > madisonjmyers@gmail.com>
>> > > > wrote:
>> > > >
>> > > >> Thanks for opening up this dialogue Felix & Luciano!
>> > > >> .....
>> > > >>
>> > > >> Additionally, Luciano mentioned that he was trying to find two
key
>> > > personas
>> > > >> for the SystemML website. Looking at the results from the SystemML
>> > > survey I
>> > > >> sent out a few weeks ago, it is clear that an overwhelming
>> majority of
>> > > >> people voted for Data Scientist- new and Data Scientist- advanced.
>> > > Input on
>> > > >> if you agree on these results would be helpful.
>> > > >>
>> > > >> ....
>> > > >>
>> > > >> Thanks again!
>> > > >> Madison
>> > > >
>> > > >
>> > > >
>> > > > I was thinking on two main personas : Data Scientist and Data
>> > Engineers.
>> > > > And at least for the Data Scientist, we might have to have topics
>> for
>> > > both
>> > > > R and Python.
>> > > >
>> > > >
>> > > > In summary, I would say :
>> > > >
>> > > >
>> > > >
>> > > > Getting Started for Data Scientists (note that we should have a
>> version
>> > > for
>> > > > R and Python):
>> > > >
>> > > > - Creating algorithms with SystemML : this is kind a helloworld
>> where a
>> > > > Data Scientist creates and runs a very simple algorithm.
>> > > >
>> > > > - Running existing algorithms with SystemML : in this scenario, we
>> > would
>> > > > guide the data scientist on how to run an algorithm from the sample
>> > > library
>> > > > from SystemML. We should also guide the data scientist to choose the
>> > > right
>> > > > algorithm for his/her specific problem.
>> > > >
>> > > > - Customizing existing algorithms with SystemML: in this scenario,
>> we
>> > > would
>> > > > guide the data scientist to start making customization and applying
>> the
>> > > > algorithm for different data sets.
>> > > >
>> > > >
>> > > >
>> > > >
>> > > > Getting started for Data Engineers:
>> > > >
>> > > > - Overview of different options/runtimes supported by SystemML
>> > > >
>> > > > - Debugging SystemML ???
>> > > >
>> > > > - Engine development guide ???
>> > > >
>> > > > Thoughts ?
>> > > >
>> > > >
>> > > > --
>> > > > Luciano Resende
>> > > > http://twitter.com/lresende1975
>> > > > http://lresende.blogspot.com/
>> > >
>> >
>> >
>> >
>> > --
>> > *Madison J. Myers*
>> > *UC Berkeley, Master of Information & Data Science '17*
>> >
>> > *King's College London, MA Political Science '14*
>> > *New York University, BA Political Science '12*
>> >
>> >    -
>> >       LinkedIn <http://linkedin.com/in/madisonjmyers>
>> >
>>
>>
>>
>> --
>> Luciano Resende
>> http://twitter.com/lresende1975
>> http://lresende.blogspot.com/
>>
>
>
>
> --
> *Madison J. Myers*
> *UC Berkeley, Master of Information & Data Science '17*
>
> *King's College London, MA Political Science '14*
> *New York University, BA Political Science '12*
>
>    -
>       LinkedIn <http://linkedin.com/in/madisonjmyers>
>
>


-- 
*Madison J. Myers*
*UC Berkeley, Master of Information & Data Science '17*

*King's College London, MA Political Science '14*
*New York University, BA Political Science '12*

   -
      LinkedIn <http://linkedin.com/in/madisonjmyers>

Mime
  • Unnamed multipart/mixed (inline, None, 0 bytes)
View raw message