Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

WIP Website changes #1784

Closed
wants to merge 5 commits into
from

Conversation

Projects
None yet
6 participants
Owner

amueller commented Mar 17, 2013

Work in progress on the website navigation.
Please comment :)

You can find the built website at
http://amueller.github.com/

Owner

agramfort commented Mar 17, 2013

can you put a built version online for the lazy ones? :)

Owner

amueller commented Mar 17, 2013

I did. There is a link in the description ;) Not sure if it is entirely up to date, I'm on the road :-/

Owner

larsmans commented Mar 17, 2013

The fonts in the menu got too small to read:

screenshot of small fonts

@agramfort agramfort commented on the diff Mar 17, 2013

doc/index.rst
+
+ iris = load_iris()
+ X, y = iris.data, iris.target
+
+ # split into training and test set
+ from sklearn.cross_validation import train_test_split
+ X_train, X_test, y_train, y_test = train_test_split(X, y)
+
+ # learn a k-nearest neighbor classificaton model
+ from sklearn.neighbors import KNeighborsClassifier
+ knn = KNeighborsClassifier(n_neighbors=3)
+ knn.fit(X_train, y_train)
+
+ KNeighborsClassifier(algorithm='auto', leaf_size=30, n_neighbors=3, p=2,
+ weights='uniform')
+
@agramfort

agramfort Mar 17, 2013

Owner

these 2 lines above should not be there.

@jaquesgrobler

jaquesgrobler Mar 18, 2013

Owner

Same as your below comment - weird without >>>

@agramfort agramfort commented on the diff Mar 17, 2013

doc/index.rst
+ from sklearn.cross_validation import train_test_split
+ X_train, X_test, y_train, y_test = train_test_split(X, y)
+
+ # learn a k-nearest neighbor classificaton model
+ from sklearn.neighbors import KNeighborsClassifier
+ knn = KNeighborsClassifier(n_neighbors=3)
+ knn.fit(X_train, y_train)
+
+ KNeighborsClassifier(algorithm='auto', leaf_size=30, n_neighbors=3, p=2,
+ weights='uniform')
+
+ # apply the model to test data
+ knn.predict(X_test)
+
+ array([0, 0, 0, 1, 0, 0, 1, 0, 2, 1, 0, 0, 2, 2, 0, 0, 2, 1, 0, 0, 1, 0, 0,
+ 2, 1, 1, 0, 2, 2, 2, 0, 0, 0, 1, 1, 2, 2, 1])
@agramfort

agramfort Mar 17, 2013

Owner

this looks weird unless you add some >>>

@amueller

amueller Mar 17, 2013

Owner

i know, working on it ;)

Alexandre Gramfort notifications@github.com schrieb:

  • from sklearn.cross_validation import train_test_split
  • X_train, X_test, y_train, y_test = train_test_split(X, y)
  • learn a k-nearest neighbor classificaton model

  • from sklearn.neighbors import KNeighborsClassifier
  • knn = KNeighborsClassifier(n_neighbors=3)
  • knn.fit(X_train, y_train)
  • KNeighborsClassifier(algorithm='auto', leaf_size=30,
    n_neighbors=3, p=2,
  •           weights='uniform')
    
  • apply the model to test data

  • knn.predict(X_test)
  • array([0, 0, 0, 1, 0, 0, 1, 0, 2, 1, 0, 0, 2, 2, 0, 0, 2, 1, 0,
    0, 1, 0, 0,
  •       2, 1, 1, 0, 2, 2, 2, 0, 0, 0, 1, 1, 2, 2, 1])
    

this looks weird unless you add some >>>


Reply to this email directly or view it on GitHub:
https://github.com/scikit-learn/scikit-learn/pull/1784/files#r3405777

Diese Nachricht wurde von meinem Android-Mobiltelefon mit K-9 Mail gesendet.

Owner

amueller commented Mar 17, 2013

i didn't change any font size iirc.

Lars Buitinck notifications@github.com schrieb:

The fonts in the menu got too small to read:

screenshot of small fonts


Reply to this email directly or view it on GitHub:
#1784 (comment)

Diese Nachricht wurde von meinem Android-Mobiltelefon mit K-9 Mail gesendet.

Owner

larsmans commented Mar 17, 2013

You're right, that was there before. Let's not fix it in this PR.

Owner

mblondel commented Mar 18, 2013

In the example, you could preprocess the data with Normalizer.

Owner

mblondel commented Mar 18, 2013

In the example, you could preprocess the data with Normalizer.

Sorry, I meant StandardScaler.

Owner

glouppe commented Mar 18, 2013

In the tutorial page (http://amueller.github.com/tutorial/index.html), the numberings appear to be quite strange. Why does it start at "1.2" for the second tutorial? Also, the section numbers appear for some subtitles but not for others.

Owner

glouppe commented Mar 18, 2013

Also, I think we should make the look of all tables of contents consistent with each other. Right now, Tutorials, User guide and Development tables of content all look different.

@jaquesgrobler jaquesgrobler commented on the diff Mar 18, 2013

doc/index.rst
+ knn = KNeighborsClassifier(n_neighbors=3)
+ knn.fit(X_train, y_train)
+
+ KNeighborsClassifier(algorithm='auto', leaf_size=30, n_neighbors=3, p=2,
+ weights='uniform')
+
+ # apply the model to test data
+ knn.predict(X_test)
+
+ array([0, 0, 0, 1, 0, 0, 1, 0, 2, 1, 0, 0, 2, 2, 0, 0, 2, 1, 0, 0, 1, 0, 0,
+ 2, 1, 1, 0, 2, 2, 2, 0, 0, 0, 1, 1, 2, 2, 1])
+
+ # compute the accuracy on test data
+ knn.score(X_test, y_test)
+
+ 0.97368421052631582
@jaquesgrobler

jaquesgrobler Mar 18, 2013

Owner

same here :) needs to look like it's an output :)

@jaquesgrobler jaquesgrobler commented on the diff Mar 18, 2013

doc/themes/scikit-learn/layout.html
-<div class="search_form">
-
-<div id="cse" style="width: 100%;"></div>
-<script src="http://www.google.com/jsapi" type="text/javascript"></script>
-<script type="text/javascript">
- google.load('search', '1', {language : 'en'});
- google.setOnLoadCallback(function() {
- var customSearchControl = new google.search.CustomSearchControl('016639176250731907682:tjtqbvtvij0');
- customSearchControl.setResultSetSize(google.search.Search.FILTERED_CSE_RESULTSET);
- var options = new google.search.DrawOptions();
- options.setAutoComplete(true);
- customSearchControl.draw('cse', options);
- }, true);
-</script>
-
-</div>
@jaquesgrobler

jaquesgrobler Mar 18, 2013

Owner

No more search bar? Just a thought, but if we still wanted it, even though it's not super useful, we could perhaps squeeze it in the sidebar (like above `News) like many sites do. Else I'm fine with it being gone too :)

@larsmans

larsmans Mar 18, 2013

Owner

Let's ditch search if it gives too many headaches. We have more important things to worry about.

Owner

jaquesgrobler commented Mar 18, 2013

Very nice @amueller ! Btw, can I merge in #1581 just to lessen the chance of merge conflicts?
It's ready, I just need a 👍

Owner

amueller commented Apr 2, 2013

I'll try to work on this a bit more soon. @GaelVaroquaux any sort of opinion already?

Owner

jaquesgrobler commented Apr 19, 2013

Hey @amueller . I had a bit of a look and discussion with @GaelVaroquaux a few days ago about the website. As he's rather busy at the moment, I'll try and convey the points to you here:

Basically, the feeling was to lean a bit more towards something in between the current docs and your version.

  • The Google Search bar - apart from people saying it doesn't work perfectly, it seems to be the best option at the moment regarding search bars. Gael was +1 for keeping it in the docs.
  • Simple renames regarding the top tabs: It was suggested that Getting Started would be a better fit than Tutorials. Another suggestion was to change Installation to Downloads, although there was no strong opinion on which is better.
  • Remove Reference/Development/Support tabs at the top. These can all be found in the userguide. We could even add the 'Support' tab into the sidebar somewhere around About us if need be.
  • It may be nice to have a bright button somewhere in the sidebar of the homepage to attract newcomers to the getting started option. Something like the orange div on the sidebar of the nisl docs that will basically take anyone that doesn't know where to begin straight to the tutorials (or Getting Started) page. I could do this if you want :)
  • Regarding the example code you added - Gael mentioned that we could also take a nice example like the Recognizing hand-written digits example, move it around a bit, as to use literal-include as an example. We wouldn't want to add a specific seperate example for this as there are all ready a mountain of them. Whichever we decide on, he was +1 for keeping the User Guide on the homepage. So then have the example code, followed by the User Guide.
  • Move the License and the Documentation Version Warning block both into the sidebar.

Let me know what your thoughts are on this when you get a gap. Basically, this summarizes the key points of our discussion. Gael, please chip in if you see anything I've got wrong here ;)
Looking forward to your feedback, @amueller :)

Owner

amueller commented Apr 20, 2013

Maybe this would be a good thing do do at the sprint? But we can try to do it now ;)
I think I had "getting started" but renamed it because @NelleV that she would look for installation under "getting started" and not "installation".
I renamed "Download" to "installation" as it describes how to install. I'm not sure what you would put on a "Download" page. Btw, the name of the file was "install" ;)

Point 3 shows a complete misunderstanding of the redesign. No, they can not!
I pulled them out of the user guide. That was the hole point - oh and Development and support could not be found in the user guide before - it could only be found on the front-page. That was one of my main criticism of the old design! Before, references was under the user guide and a separate tab. I removed it from the user guide!

The rest seems like minor details that I am sure we an figure out and for which I'll have to have another look.

Owner

amueller commented Jul 26, 2013

superseded by #2201.

@amueller amueller closed this Jul 26, 2013

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment