Updated Documentation

SekouD · Jul 10, 2018 · 68a1fb3 · 68a1fb3
1 parent 9fc4595
commit 68a1fb3
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 4 deletions.
diff --git a/README.rst b/README.rst
@@ -20,7 +20,7 @@ mlconjug
         :alt: Windows Continuous Integration Status
 
 .. image:: https://readthedocs.org/projects/mlconjug/badge/?version=latest
-        :target: https://mlconjug.readthedocs.io/en/latest/?badge=latest
+        :target: https://mlconjug.readthedocs.io/en/latest
         :alt: Documentation Status
 
 .. image:: https://pyup.io/repos/github/SekouD/mlconjug/shield.svg

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -44,16 +44,21 @@ To use MLConjug in a project and train a new model::
     # Feature reduction
     feature_reductor = SelectFromModel(LinearSVC(penalty="l1", max_iter=12000, dual=False, verbose=0))
 
-    #Prediction Classifier
+    # Prediction Classifier
     classifier = SGDClassifier(loss="log", penalty='elasticnet', l1_ratio=0.15, max_iter=4000, alpha=1e-5, random_state=42, verbose=0)
 
+    # Initialize Data Set
+    dataset = DataSet(Verbiste().verbs)
+    dataset.construct_dict_conjug()
+    dataset.split_data(proportion=0.9)
+
     # Initialize Conjugator
     model = mlconjug.Model(vectorizer, feature_reductor, classifier)
     conjugator = mlconjug.Conjugator(lang, model)
 
     #Training and prediction
-    conjugator.model.train(conjugator.data_set.train_input, conjugator.data_set.train_labels)
-    predicted = conjugator.model.predict(conjugator.data_set.test_input)
+    conjugator.model.train(data_set.train_input, data_set.train_labels)
+    predicted = conjugator.model.predict(data_set.test_input)
 
     # Assess the performance of the model's predictions
     score = len([a == b for a, b in zip(predicted, conjugator.data_set.templates_list) if a == b]) / len(predicted)