teacher.md

ReImproveJS

Globals / Teacher /

Class: Teacher

Hierarchy

• Teacher

Index

Constructors

• constructor

Properties

• agents
• config
• currentEpsilon
• currentLessonLength
• lessonsTaught
• name
• onLearningLessonEnded
• onLessonEnded
• onTeachingEnded
• state

Accessors

• Name
• OnLearningLessonEnded
• OnLessonEnded
• OnTeachingEnded
• State

Methods

• affectStudent
• getData
• removeStudent
• reset
• resetLesson
• start
• startTeaching
• stop
• stopTeaching
• teach
• updateParameters

Constructors

constructor

+ new Teacher(config?: TeachingConfig, name?: string): Teacher

Defined in reimprove/teacher.ts:60

Parameters:

Name	Type
config?	TeachingConfig
name?	string

Returns: Teacher

---

Properties

agents

● agents: Set<DQAgent>

Defined in reimprove/teacher.ts:51

---

config

● config: TeachingConfig

Defined in reimprove/teacher.ts:48

---

currentEpsilon

● currentEpsilon: number

Defined in reimprove/teacher.ts:60

---

currentLessonLength

● currentLessonLength: number

Defined in reimprove/teacher.ts:53

---

lessonsTaught

● lessonsTaught: number

Defined in reimprove/teacher.ts:54

---

name

● name: string

Defined in reimprove/teacher.ts:47

---

onLearningLessonEnded

● onLearningLessonEnded: function

Defined in reimprove/teacher.ts:56

Type declaration:

▸ (teacher: string): void

Parameters:

Name	Type
teacher	string

---

onLessonEnded

● onLessonEnded: function

Defined in reimprove/teacher.ts:57

Type declaration:

▸ (teacher: string, lessonNumber: number): void

Parameters:

Name	Type
teacher	string
lessonNumber	number

---

onTeachingEnded

● onTeachingEnded: function

Defined in reimprove/teacher.ts:58

Type declaration:

▸ (teacher: string): void

Parameters:

Name	Type
teacher	string

---

state

● state: TeachingState

Defined in reimprove/teacher.ts:49

---

Accessors

Name

● get Name(): string

Defined in reimprove/teacher.ts:210

Returns: string

● set Name(name: string): void

Defined in reimprove/teacher.ts:206

Parameters:

Name	Type
name	string

Returns: void

---

OnLearningLessonEnded

● set OnLearningLessonEnded(callback: function): void

Defined in reimprove/teacher.ts:194

Parameters:

■ callback: function

▸ (teacher: string): void

Parameters:

Name	Type
teacher	string

Returns: void

---

OnLessonEnded

● set OnLessonEnded(callback: function): void

Defined in reimprove/teacher.ts:198

Parameters:

■ callback: function

▸ (teacher: string, lessonNumber: number): void

Parameters:

Name	Type
teacher	string
lessonNumber	number

Returns: void

---

OnTeachingEnded

● set OnTeachingEnded(callback: function): void

Defined in reimprove/teacher.ts:202

Parameters:

■ callback: function

▸ (teacher: string): void

Parameters:

Name	Type
teacher	string

Returns: void

---

State

● get State(): TeachingState

Defined in reimprove/teacher.ts:214

Returns: TeachingState

---

Methods

affectStudent

▸ affectStudent(agent: DQAgent): void

Defined in reimprove/teacher.ts:76

Parameters:

Name	Type
agent	DQAgent

Returns: void

---

getData

▸ getData(): TeacherTrackingInformation

Defined in reimprove/teacher.ts:165

Returns: TeacherTrackingInformation

---

removeStudent

▸ removeStudent(agent: DQAgent): boolean

Defined in reimprove/teacher.ts:80

Parameters:

Name	Type
agent	DQAgent

Returns: boolean

---

reset

▸ reset(): void

Defined in reimprove/teacher.ts:184

Returns: void

---

resetLesson

▸ resetLesson(): void

Defined in reimprove/teacher.ts:179

Returns: void

---

start

▸ start(): void

Defined in reimprove/teacher.ts:84

Returns: void

---

startTeaching

▸ startTeaching(): void

Defined in reimprove/teacher.ts:151

Returns: void

---

stop

▸ stop(): void

Defined in reimprove/teacher.ts:190

Returns: void

---

stopTeaching

▸ stopTeaching(): void

Defined in reimprove/teacher.ts:147

Returns: void

---

teach

▸ teach(inputs: number[]): Promise<Map<string, number>>

Defined in reimprove/teacher.ts:90

Parameters:

Name	Type
inputs	number[]

Returns: Promise<Map<string, number>>

---

updateParameters

▸ updateParameters(): void

Defined in reimprove/teacher.ts:156

Returns: void

---