twisterl 0.5.1

Reinforcement learning primitives and a Python extension for high performance training and inference.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

// -*- coding: utf-8 -*-
/* 
(C) Copyright 2025 IBM. All Rights Reserved.

This code is licensed under the Apache License, Version 2.0. You may
obtain a copy of this license in the LICENSE.txt file in the root directory
of this source tree or at http://www.apache.org/licenses/LICENSE-2.0.

Any modifications or derivative works of this code must retain this
copyright notice, and modified files need to carry a notice indicating
that they have been altered from the originals.
*/

use std::borrow::Borrow;

use pyo3::prelude::*;
use pyo3::types::PyAny;
use crate::rl::env::Env;
use crate::python_interface::env::PyBaseEnv;

pub struct PyEnvImpl {
    py_env: Py<PyAny>, // Reference to the Python object implementing the environment
    difficulty: usize
}


impl Clone for PyEnvImpl {
    fn clone(&self) -> Self {
        Python::with_gil(|py| {
            PyEnvImpl {
                py_env: self.py_env.call_method0(py, "copy").expect("Python `copy` method failed."),
                difficulty: self.difficulty
            }
        })
    }
}


impl PyEnvImpl {
    /// Constructor: Create a new `PythonEnv` from a Python object
    pub fn new(py_env: Py<PyAny>) -> Self {
        PyEnvImpl { py_env, difficulty:1 }
    }
}

impl Env for PyEnvImpl {
    fn as_any(&self) -> &dyn std::any::Any {
        self
    }

    fn as_any_mut(&mut self) -> &mut dyn std::any::Any {
        self
    }

    // Sets the current difficulty
    fn set_difficulty(&mut self, difficulty: usize) {
        self.difficulty = difficulty;
    }

    // Returns current difficulty
    fn get_difficulty(&self) -> usize {
        self.difficulty
    }

    fn set_state(&mut self, state: Vec<i64>) {
        Python::with_gil(|py| {
            let py_env = self.py_env.borrow();
            py_env.call_method1(py, "set_state", (state,))
                .expect("Python `set_state` method failed.");
        });
    }

    fn num_actions(&self) -> usize {
        Python::with_gil(|py| {
            let py_env = self.py_env.borrow();
            py_env
                .call_method0(py, "num_actions")
                .and_then(|val| val.extract::<usize>(py))
                .expect("Python `num_actions` method must return an integer.")
        })
    }

    fn obs_shape(&self) -> Vec<usize> {
        Python::with_gil(|py| {
            let py_env = self.py_env.borrow();
            py_env
                .call_method0(py, "obs_shape")
                .and_then(|val| val.extract::<Vec<usize>>(py))
                .expect("Python `obs_shape` method must return a list of integers.")
        })
    }
    
    fn reset(&mut self) {
        Python::with_gil(|py| {
            let py_env = self.py_env.borrow();
            py_env
                .call_method1(py, "reset", (self.difficulty,))
                .expect("Python `reset` method failed.");
        });
    }

    fn step(&mut self, action: usize) {
        Python::with_gil(|py| {
            let py_env = self.py_env.borrow();
            py_env
                .call_method1(py, "next", (action,))
                .expect("Python `next` method failed.");
        });
    }

    fn masks(&self) -> Vec<bool> {
        Python::with_gil(|py| {
            let py_env = self.py_env.borrow();
            py_env
                .call_method0(py, "masks")
                .and_then(|val| val.extract::<Vec<bool>>(py))
                .expect("Python `masks` method must return a list of booleans.")
        })
    }

    fn is_final(&self) -> bool {
        Python::with_gil(|py| {
            let py_env = self.py_env.borrow();
            py_env
                .call_method0(py, "is_final")
                .and_then(|val| val.extract::<bool>(py))
                .expect("Python `is_final` method must return a boolean.")
        })
    }

    fn reward(&self) -> f32 {
        Python::with_gil(|py| {
            let py_env = self.py_env.borrow();
            py_env
                .call_method0(py, "value")
                .and_then(|val| val.extract::<f32>(py))
                .expect("Python `value` method must return a float.")
        })
    }

    fn success(&self) -> bool {
        Python::with_gil(|py| {
            let py_env = self.py_env.borrow();
            py_env
                .call_method0(py, "success")
                .and_then(|val| val.extract::<bool>(py))
                .expect("Python `success` method must return a bool.")
        })
    }

    fn observe(&self) -> Vec<usize> {
        Python::with_gil(|py| {
            let py_env = self.py_env.borrow();
            py_env
                .call_method0(py, "observe")
                .and_then(|val| val.extract::<Vec<usize>>(py))
                .expect("Python `observe` method must return a list of integers.")
        })
    }
}


#[pyclass(subclass, extends=PyBaseEnv)]
pub struct PyEnv {}

#[pymethods]
impl PyEnv {
    #[new]
    pub fn new(py_env: Py<PyAny>) -> (Self, PyBaseEnv) {
        let env_impl = PyEnvImpl::new(py_env);
        let env = Box::new(env_impl);
        (PyEnv {}, PyBaseEnv { env: env })
    }
}