From 78b607b4d1e9f4b7baa3d1b18318d431d1727272 Mon Sep 17 00:00:00 2001
From: William Waites <xgb21195@cpunode2.cis.strath.ac.uk>
Date: Sun, 21 Jan 2024 13:30:59 +0000
Subject: [PATCH] add README
---
imitation/README.md | 14 ++++++++++++++
imitation/imitation/server.py | 4 ++--
imitation/setup.py | 4 ++--
3 files changed, 18 insertions(+), 4 deletions(-)
create mode 100644 imitation/README.md
diff --git a/imitation/README.md b/imitation/README.md
new file mode 100644
index 0000000..d1e7d11
--- /dev/null
+++ b/imitation/README.md
@@ -0,0 +1,14 @@
+# The Imitation Game
+
+This is a server for playing Turing's Imitation Game. It is intended
+for use in a classroom setting. Installation is as usual for Python
+packages, it requires Python 3, the `llm` wrapper package, an NumPy.
+
+By default the server listens on TCP port 1950 (the year of Turing's
+"Computing Machinery and Intelligence" paper. Connecting to this port,
+using e.g. `telnet` or `netcat` will start a session. The role of
+interrogator or player is randomly assigned. An interrogator may be
+paired with either a human or a suitably prompted language model. The
+task of the interrogator is to determine if they are conversing with a
+human or a machine.
+
diff --git a/imitation/imitation/server.py b/imitation/imitation/server.py
index 693dfa7..5a6b8c7 100644
--- a/imitation/imitation/server.py
+++ b/imitation/imitation/server.py
@@ -117,7 +117,7 @@ class Interrogator(Interlocutor):
def handle(self):
self.log.info("connecting...")
self.write(f"""
-Welcome to the Imitation Game. Your role is "interrogator". You get to
+Welcome to the Imitation Game. Your role is INTERROGATOR. You get to
ask {self.n} questions of your interlocutor to determine if they are a
human or a machine. At the end of the session you will be asked which
you think they are and why. If you have made up your mind and want to
@@ -180,7 +180,7 @@ class Human(Interlocutor):
def handle(self):
self.log.info("connecting...")
self.write(f"""
-Welcome to the Imitation Game. Your role is HUMAN. You will be asked
+Welcome to the Imitation Game. Your role is PLAYER. You will be asked
{self.n} questions by an interlocutor who is attempting to find out if
you are a human or a machine. Your task is to convince them that you
are human. Good luck!
diff --git a/imitation/setup.py b/imitation/setup.py
index f77d1c9..340ab8f 100644
--- a/imitation/setup.py
+++ b/imitation/setup.py
@@ -4,7 +4,7 @@ from setuptools import setup, find_packages
setup(name='imitation',
version='0.2',
- description='Turing Test',
+ description="Turing's Imitation Game",
author=['William Waites'],
author_email='william.waites@strath.ac.uk',
keywords=['AI'],
@@ -34,7 +34,7 @@ setup(name='imitation',
],
entry_points={
'console_scripts': [
- 'imitation_server = imitation.server:cli',
+ 'imitation = imitation.server:cli',
],
},
)
--
GitLab