LLamaSharp/docs/xmldocs/llama.instructexecutor.md

# InstructExecutor

Namespace: LLama

The LLama executor for instruct mode.

```csharp
public class InstructExecutor : StatefulExecutorBase, LLama.Abstractions.ILLamaExecutor
```

Inheritance [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object) → [StatefulExecutorBase](./llama.statefulexecutorbase.md) → [InstructExecutor](./llama.instructexecutor.md)<br>
Implements [ILLamaExecutor](./llama.abstractions.illamaexecutor.md)

## Properties

### **Model**

The mode used by the executor.

```csharp
public LLamaModel Model { get; }
```

#### Property Value

[LLamaModel](./llama.llamamodel.md)<br>

## Constructors

### **InstructExecutor(LLamaModel, String, String)**



```csharp
public InstructExecutor(LLamaModel model, string instructionPrefix, string instructionSuffix)
```

#### Parameters

`model` [LLamaModel](./llama.llamamodel.md)<br>

`instructionPrefix` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>

`instructionSuffix` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>

## Methods

### **GetStateData()**

```csharp
public ExecutorBaseState GetStateData()
```

#### Returns

[ExecutorBaseState](./llama.statefulexecutorbase.executorbasestate.md)<br>

### **LoadState(ExecutorBaseState)**

```csharp
public void LoadState(ExecutorBaseState data)
```

#### Parameters

`data` [ExecutorBaseState](./llama.statefulexecutorbase.executorbasestate.md)<br>

### **SaveState(String)**

```csharp
public void SaveState(string filename)
```

#### Parameters

`filename` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>

### **LoadState(String)**

```csharp
public void LoadState(string filename)
```

#### Parameters

`filename` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>

### **GetLoopCondition(InferStateArgs)**

```csharp
protected bool GetLoopCondition(InferStateArgs args)
```

#### Parameters

`args` [InferStateArgs](./llama.statefulexecutorbase.inferstateargs.md)<br>

#### Returns

[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>

### **PreprocessInputs(String, InferStateArgs)**

```csharp
protected void PreprocessInputs(string text, InferStateArgs args)
```

#### Parameters

`text` [String](https://docs.microsoft.com/en-us/dotnet/api/system.string)<br>

`args` [InferStateArgs](./llama.statefulexecutorbase.inferstateargs.md)<br>

### **PostProcess(InferenceParams, InferStateArgs, IEnumerable`1&)**

```csharp
protected bool PostProcess(InferenceParams inferenceParams, InferStateArgs args, IEnumerable`1& extraOutputs)
```

#### Parameters

`inferenceParams` [InferenceParams](./llama.common.inferenceparams.md)<br>

`args` [InferStateArgs](./llama.statefulexecutorbase.inferstateargs.md)<br>

`extraOutputs` [IEnumerable`1&](https://docs.microsoft.com/en-us/dotnet/api/system.collections.generic.ienumerable-1&)<br>

#### Returns

[Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean)<br>

### **InferInternal(InferenceParams, InferStateArgs)**

```csharp
protected void InferInternal(InferenceParams inferenceParams, InferStateArgs args)
```

#### Parameters

`inferenceParams` [InferenceParams](./llama.common.inferenceparams.md)<br>

`args` [InferStateArgs](./llama.statefulexecutorbase.inferstateargs.md)<br>