Update docs

natsuozawa · Mar 29, 2024 · c3cf37f · c3cf37f
1 parent 288229c
commit c3cf37f
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/docs/getting_started.rst b/docs/getting_started.rst
@@ -40,6 +40,7 @@ Quick Start Example
   from socialchoicekit.deterministic_scoring import Plurality, SocialWelfare
   from socialchoicekit.elicitation_voting import KARV
   from socialchoicekit.elicitation_utils import ValuationProfileElicitor, SynchronousStdInElicitor
+  from socialchoicekit.distortion import distortion
 
   url = 'https://www.preflib.org/static/data/agh/00009-00000001.soc'
 
@@ -70,7 +71,7 @@ Quick Start Example
   plurality_winner = plurality.scf(profile)
   print(plurality.score(profile))
   print("Plurality winner: ", plurality_winner)
-  print("Distortion: ", optimal_welfare / social_welfare[plurality_winner - 1])
+  print("Distortion: ", distortion(plurality_winner, valuation_profile))
 
   # 3) Elicitation (query)-based voting
   print("----- 3) Elicitation-based voting -----")
@@ -80,7 +81,7 @@ Quick Start Example
   karv_winner = karv.scf(profile, valuation_profile_elicitor)
   # karv_winner = karv.scf(profile, stdin_elicitor)
   print("KARV winner: ", karv_winner)
-  print("Distortion: ", optimal_welfare / social_welfare[karv_winner - 1])
+  print("Distortion: ", distortion(karv_winner, valuation_profile))
 
 User Guide
 ----------