modurl 0.1.0

Modular reinforcement learning algorithms and utilities built on Candle
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
use bon::bon;
use candle_core::{D, DType, IndexOp, Tensor};
use candle_nn::{Optimizer, loss};
use std::marker::PhantomData;

use crate::{
    buffers::{experience, rollout_buffer::RolloutBuffer},
    gym::{MultiGym, MultiGymStepInfo},
    models::probabilistic_model::ProbabilisticPolicy,
    objectives::clipped_value_loss,
    parameter_schedule::{ConstantSchedule, ParameterSchedule, ScheduleProgress},
    sampling::shuffle_with_device_rng,
    spaces,
    tensor_operations::normalize_tensor,
};

#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
pub enum PPOConfigurationError {
    #[error("batch size must be nonzero")]
    ZeroBatchSize,
    #[error("minibatch size must be nonzero")]
    ZeroMiniBatchSize,
    #[error("the number of optimization epochs must be nonzero")]
    ZeroEpochs,
    #[error("training horizon must be nonzero")]
    ZeroTrainingHorizon,
    #[error("gamma must be finite and in 0..=1")]
    InvalidGamma,
    #[error("GAE lambda must be finite and in 0..=1")]
    InvalidGaeLambda,
    #[error("value coefficient must be finite and nonnegative")]
    InvalidValueCoefficient,
    #[error("entropy coefficient must be finite and nonnegative")]
    InvalidEntropyCoefficient,
    #[error("gradient clip must be finite and positive")]
    InvalidGradientClip,
    #[error("PPO requires a floating-point dtype")]
    InvalidDType,
    #[error("the environment count must be nonzero")]
    ZeroEnvironments,
    #[error("batch size must be divisible by the environment count")]
    BatchNotDivisibleByEnvironmentCount,
}

#[derive(Debug, thiserror::Error)]
pub enum PPOError<AE, GE, SE>
where
    AE: std::fmt::Debug,
    GE: std::fmt::Debug,
    SE: std::fmt::Debug,
{
    #[error("policy failed: {0}")]
    PolicyError(#[source] AE),
    #[error("gym failed: {0}")]
    GymError(#[source] GE),
    #[error("PPO tensor operation failed: {0}")]
    TensorError(#[source] candle_core::Error),
    #[error("space operation failed: {0}")]
    SpaceError(#[source] SE),
    #[error("invalid PPO configuration: {0}")]
    ConfigurationError(#[source] PPOConfigurationError),
    #[error("termination batches differ in length: {dones} dones and {truncateds} truncations")]
    MismatchedTerminationBatch { dones: usize, truncateds: usize },
    #[error("no prepared rollout is available")]
    MissingPreparedRollout,
    #[error("old value estimates are missing")]
    MissingOldValues,
}

impl<AE, GE, SE> From<PPOConfigurationError> for PPOError<AE, GE, SE>
where
    AE: std::fmt::Debug,
    GE: std::fmt::Debug,
    SE: std::fmt::Debug,
{
    fn from(error: PPOConfigurationError) -> Self {
        Self::ConfigurationError(error)
    }
}

impl<AE, GE, SE> From<candle_core::Error> for PPOError<AE, GE, SE>
where
    AE: std::fmt::Debug,
    GE: std::fmt::Debug,
    SE: std::fmt::Debug,
{
    fn from(err: candle_core::Error) -> Self {
        PPOError::TensorError(err)
    }
}

use super::Agent;

#[derive(Debug, Clone)]
struct PPOPreparedExperience {
    advantages: Tensor,
    returns: Tensor,
    /// V(s) under the rollout-collection network, for PPO2-style value-loss clipping.
    old_values: Option<Tensor>,
}

#[derive(Debug, Clone)]
struct PPOExperience {
    states: Tensor,
    next_states: Tensor,
    actions: Tensor,
    rewards: Tensor,
    training_rewards: Tensor,
    next_dones: Vec<bool>,
    truncateds: Vec<bool>,
    log_probs: Tensor,
    prepared: Option<PPOPreparedExperience>,
}

struct PPOCollectionAction {
    policy_actions: Tensor,
    environment_actions: Tensor,
    log_probs: Tensor,
}

struct PPOPreparedRolloutBatch {
    advantages: Tensor,
    returns: Tensor,
    old_values: Option<Tensor>,
}

struct PPORolloutBatch {
    states: Tensor,
    next_states: Tensor,
    actions: Tensor,
    rewards: Tensor,
    training_rewards: Tensor,
    next_dones: Tensor,
    truncateds: Tensor,
    log_probs: Tensor,
    prepared: Option<PPOPreparedRolloutBatch>,
}

impl PPOPreparedRolloutBatch {
    fn batch(experiences: &[PPOExperience]) -> Result<Option<Self>, candle_core::Error> {
        let prepared = experiences
            .iter()
            .map(|experience| experience.prepared.as_ref())
            .collect::<Option<Vec<_>>>();
        let Some(prepared) = prepared else {
            assert!(
                experiences
                    .iter()
                    .all(|experience| experience.prepared.is_none()),
                "PPO rollout preparation must be all-or-nothing"
            );
            return Ok(None);
        };

        let advantages = prepared
            .iter()
            .map(|prepared| prepared.advantages.clone())
            .collect::<Vec<_>>();
        let returns = prepared
            .iter()
            .map(|prepared| prepared.returns.clone())
            .collect::<Vec<_>>();
        let old_values = prepared
            .iter()
            .map(|prepared| prepared.old_values.clone())
            .collect::<Option<Vec<_>>>();

        Ok(Some(Self {
            advantages: Tensor::stack(&advantages, 0)?,
            returns: Tensor::stack(&returns, 0)?,
            old_values: old_values
                .map(|old_values| Tensor::stack(&old_values, 0))
                .transpose()?,
        }))
    }
}

#[bon]
impl PPOExperience {
    /// Creates one vectorized rollout transition.
    ///
    /// `states` and `next_states` are `[env_count, ...observation_shape]`,
    /// `actions` is `[env_count, ...action_shape]`; `rewards`,
    /// `training_rewards`, and `log_probs` are `[env_count]`. `rewards`
    /// preserves the environment values for logging, while `training_rewards`
    /// may contain bootstrap corrections for nonterminal truncations. Prepared
    /// PPO training data is added internally after rollout collection.
    #[builder]
    pub fn new(
        states: Tensor,
        next_states: Tensor,
        actions: Tensor,
        rewards: Tensor,
        training_rewards: Tensor,
        next_dones: Vec<bool>,
        truncateds: Vec<bool>,
        log_probs: Tensor,
    ) -> Self {
        Self {
            states,
            next_states,
            actions,
            rewards,
            training_rewards,
            next_dones,
            truncateds,
            log_probs,
            prepared: None,
        }
    }
}

impl experience::Experience for PPOExperience {
    type Batch = PPORolloutBatch;
    type Error = candle_core::Error;
    fn batch(experiences: &[Self]) -> Result<Self::Batch, Self::Error> {
        let first = experiences
            .first()
            .expect("cannot batch an empty PPO rollout");
        Ok(PPORolloutBatch {
            states: experience::stack_tensor_field(experiences, |experience| {
                experience.states.clone()
            })?,
            next_states: experience::stack_tensor_field(experiences, |experience| {
                experience.next_states.clone()
            })?,
            actions: experience::stack_tensor_field(experiences, |experience| {
                experience.actions.clone()
            })?,
            rewards: experience::stack_tensor_field(experiences, |experience| {
                experience.rewards.clone()
            })?,
            training_rewards: experience::stack_tensor_field(experiences, |experience| {
                experience.training_rewards.clone()
            })?,
            next_dones: experience::stack_bool_field(
                experiences,
                |experience| &experience.next_dones,
                first.states.device(),
            )?,
            truncateds: experience::stack_bool_field(
                experiences,
                |experience| &experience.truncateds,
                first.states.device(),
            )?,
            log_probs: experience::stack_tensor_field(experiences, |experience| {
                experience.log_probs.clone()
            })?,
            prepared: PPOPreparedRolloutBatch::batch(experiences)?,
        })
    }
}

struct PPOLoggingInfo<'a, I> {
    logger: &'a mut dyn PPOLogger<I>,
    epoch: usize,
    timestep: usize,
}

impl<'a, I> PPOLoggingInfo<'a, I> {
    fn new(logger: &'a mut dyn PPOLogger<I>) -> Self {
        Self {
            logger,
            epoch: 0,
            timestep: 0,
        }
    }
}

pub struct PPOLogEntry {
    pub actor_loss: Tensor,
    pub critic_loss: Tensor,
    pub entropy: Tensor,
    pub kl_divergence: Tensor,
    pub explained_variance: Tensor,
    pub rewards: Tensor,
    pub epoch: usize,
    pub timestep: usize,
    pub returns: Tensor,
    pub advantages: Tensor,
}

pub struct PPOCollectionLogEntry<I = ()> {
    pub collection_rewards: Tensor,
    pub infos: Vec<I>,
    pub collection_timestep: usize,
    pub completed_episodes: Vec<PPOEpisodeLogEntry>,
}

pub struct PPOEpisodeLogEntry {
    pub environment_index: usize,
    pub episode_return: f32,
    pub episode_length: usize,
    pub terminated: bool,
    pub truncated: bool,
    pub collection_timestep: usize,
}

struct PPOEpisodeTracker {
    returns: Vec<f32>,
    lengths: Vec<usize>,
}

impl PPOEpisodeTracker {
    fn new(environment_count: usize) -> Self {
        Self {
            returns: vec![0.0; environment_count],
            lengths: vec![0; environment_count],
        }
    }

    fn environment_count(&self) -> usize {
        self.returns.len()
    }

    fn clear(&mut self) {
        self.returns.clear();
        self.lengths.clear();
    }

    fn record(
        &mut self,
        environment_index: usize,
        reward: f32,
        terminated: bool,
        truncated: bool,
        collection_timestep: usize,
    ) -> Option<PPOEpisodeLogEntry> {
        self.returns[environment_index] += reward;
        self.lengths[environment_index] += 1;
        if !terminated && !truncated {
            return None;
        }

        let entry = PPOEpisodeLogEntry {
            environment_index,
            episode_return: self.returns[environment_index],
            episode_length: self.lengths[environment_index],
            terminated,
            truncated,
            collection_timestep,
        };
        self.returns[environment_index] = 0.0;
        self.lengths[environment_index] = 0;
        Some(entry)
    }
}

pub trait PPOLogger<I = ()> {
    fn log(&mut self, info: &PPOLogEntry);

    fn log_collection(&mut self, _info: &PPOCollectionLogEntry<I>) {}
}

#[derive(Clone)]
struct PPOLosses {
    actor_loss: Tensor,
    critic_loss: Tensor,
}

/// Returns scalar population variance for `values` of arbitrary shape `[...]`.
fn population_variance(values: &Tensor) -> candle_core::Result<Tensor> {
    let mean = values.mean_all()?.broadcast_as(values.shape())?;
    (values - mean)?.sqr()?.mean_all()
}

/// Returns scalar explained variance for `returns` and `rollout_values` with
/// identical shape `[sample_count]`.
fn compute_explained_variance(
    returns: &Tensor,
    rollout_values: &Tensor,
) -> candle_core::Result<Tensor> {
    let return_variance = population_variance(returns)?;
    let residuals = (returns - rollout_values)?;
    let residual_variance = population_variance(&residuals)?;
    let explained_variance = (1.0 - residual_variance.broadcast_div(&return_variance)?)?;

    let zero = return_variance.zeros_like()?;
    let nan = zero.affine(f64::NAN, f64::NAN)?;
    return_variance
        .eq(&zero)?
        .where_cond(&nan, &explained_variance)
}

pub struct FakeOptimizer(());

impl Optimizer for FakeOptimizer {
    type Config = ();
    fn new(_vars: Vec<candle_core::Var>, _config: Self::Config) -> candle_core::Result<Self> {
        panic!("FakeOptimizer should never be used");
    }

    fn step(&mut self, _grads: &candle_core::backprop::GradStore) -> candle_core::Result<()> {
        panic!("FakeOptimizer should never be used");
    }

    fn learning_rate(&self) -> f64 {
        panic!("FakeOptimizer should never be used");
    }

    fn set_learning_rate(&mut self, _lr: f64) {
        panic!("FakeOptimizer should never be used");
    }
}

pub enum PPONetworkInfo<O1, E, O2 = FakeOptimizer> {
    Shared(SharedPPONetwork<O1, E>),
    Separate(SeparatePPONetwork<O1, O2, E>),
}

/// Shared network architecture for PPO
/// The output of the shared network is fed into both the actor and critic heads
pub struct SharedPPONetwork<O, E> {
    optimizer: O,
    shared_network: Box<dyn candle_core::Module>,
    critic_head: Box<dyn candle_core::Module>,
    actor_head: Box<dyn ProbabilisticPolicy<Error = E>>,
    lr_scheduler: Option<Box<dyn ParameterSchedule>>,
}

#[bon]
impl<O, E> SharedPPONetwork<O, E>
where
    O: Optimizer,
    E: std::fmt::Debug,
{
    #[builder]
    pub fn new(
        optimizer: O,
        #[builder(with = |network: impl candle_core::Module + 'static| Box::new(network))]
        shared_network: Box<dyn candle_core::Module>,
        #[builder(with = |network: impl candle_core::Module + 'static| Box::new(network))]
        critic_head: Box<dyn candle_core::Module>,
        #[builder(with = |policy: impl ProbabilisticPolicy<Error = E> + 'static| Box::new(policy))]
        actor_head: Box<dyn ProbabilisticPolicy<Error = E>>,
        #[builder(with = |schedule: impl ParameterSchedule + 'static| Box::new(schedule))]
        lr_scheduler: Option<Box<dyn ParameterSchedule>>,
    ) -> Self {
        Self {
            optimizer,
            shared_network,
            critic_head,
            actor_head,
            lr_scheduler,
        }
    }

    pub(crate) fn from_boxed(
        optimizer: O,
        shared_network: Box<dyn candle_core::Module>,
        critic_head: Box<dyn candle_core::Module>,
        actor_head: Box<dyn ProbabilisticPolicy<Error = E>>,
        lr_scheduler: Option<Box<dyn ParameterSchedule>>,
    ) -> Self {
        Self {
            optimizer,
            shared_network,
            critic_head,
            actor_head,
            lr_scheduler,
        }
    }
}

pub struct SeparatePPONetwork<O1, O2, E> {
    actor_optimizer: O1,
    critic_optimizer: O2,
    actor_network: Box<dyn ProbabilisticPolicy<Error = E>>,
    critic_network: Box<dyn candle_core::Module>,
    actor_lr_scheduler: Option<Box<dyn ParameterSchedule>>,
    critic_lr_scheduler: Option<Box<dyn ParameterSchedule>>,
    combined_loss: bool,
}

#[bon]
impl<O1, O2, E> SeparatePPONetwork<O1, O2, E>
where
    O1: Optimizer,
    O2: Optimizer,
    E: std::fmt::Debug,
{
    #[builder]
    pub fn new(
        actor_optimizer: O1,
        critic_optimizer: O2,
        #[builder(with = |policy: impl ProbabilisticPolicy<Error = E> + 'static| Box::new(policy))]
        actor_network: Box<dyn ProbabilisticPolicy<Error = E>>,
        #[builder(with = |network: impl candle_core::Module + 'static| Box::new(network))]
        critic_network: Box<dyn candle_core::Module>,
        #[builder(with = |schedule: impl ParameterSchedule + 'static| Box::new(schedule))]
        actor_lr_scheduler: Option<Box<dyn ParameterSchedule>>,
        #[builder(with = |schedule: impl ParameterSchedule + 'static| Box::new(schedule))]
        critic_lr_scheduler: Option<Box<dyn ParameterSchedule>>,
        #[builder(default = false)] combined_loss: bool,
    ) -> Self {
        Self {
            actor_optimizer,
            critic_optimizer,
            actor_network,
            critic_network,
            actor_lr_scheduler,
            critic_lr_scheduler,
            combined_loss,
        }
    }

    pub(crate) fn from_boxed(
        actor_optimizer: O1,
        critic_optimizer: O2,
        actor_network: Box<dyn ProbabilisticPolicy<Error = E>>,
        critic_network: Box<dyn candle_core::Module>,
        actor_lr_scheduler: Option<Box<dyn ParameterSchedule>>,
        critic_lr_scheduler: Option<Box<dyn ParameterSchedule>>,
        combined_loss: bool,
    ) -> Self {
        Self {
            actor_optimizer,
            critic_optimizer,
            actor_network,
            critic_network,
            actor_lr_scheduler,
            critic_lr_scheduler,
            combined_loss,
        }
    }
}

pub struct PPOAgent<'a, O1, O2, AE, GE, SE, I = ()>
where
    O1: Optimizer,
    O2: Optimizer,
    AE: std::fmt::Debug,
    GE: std::fmt::Debug,
    SE: std::fmt::Debug,
{
    clipped: bool,
    clip_value_loss: bool,
    gamma: f32,
    gae_lambda: f32,
    clip_range: Box<dyn ParameterSchedule>,
    normalize_advantage: bool,
    normalize_returns: bool,
    vf_coef: f32,
    ent_coef: f32,
    action_space: Box<dyn spaces::Space<Error = SE>>,
    network_info: PPONetworkInfo<O1, AE, O2>,
    rollout_buffer: RolloutBuffer<PPOExperience>,
    mini_batch_size: usize,
    num_epochs: usize,
    batch_size: usize,
    schedule_progress: ScheduleProgress,
    logging_info: Option<PPOLoggingInfo<'a, I>>,
    gradient_clip: f32,
    current_states: Option<Tensor>,
    episode_tracker: PPOEpisodeTracker,
    dtype: DType,
    _phantom: PhantomData<GE>,
}

#[bon]
impl<'a, O1, O2, AE, GE, SE, I> PPOAgent<'a, O1, O2, AE, GE, SE, I>
where
    O1: Optimizer,
    O2: Optimizer,
    AE: std::fmt::Debug,
    GE: std::fmt::Debug,
    SE: std::fmt::Debug,
{
    #[builder]
    pub fn new(
        action_space: Box<dyn spaces::Space<Error = SE>>,
        network_info: PPONetworkInfo<O1, AE, O2>,
        #[builder(default = true)] clipped: bool,
        // PPO2/CleanRL-style value-loss clipping. Disabled by default because
        // its usefulness is task- and reward-scale-dependent.
        // research has shown it's often harmful
        #[builder(default = false)] clip_value_loss: bool,
        #[builder(default = 0.99)] gamma: f32,
        #[builder(default = 0.95)] gae_lambda: f32,
        #[builder(
            default = Box::new(ConstantSchedule::new(0.1)),
            with = |schedule: impl ParameterSchedule + 'static| Box::new(schedule)

        )]
        clip_range: Box<dyn ParameterSchedule>,
        #[builder(default = true)] normalize_advantage: bool,
        #[builder(default = false)] normalize_returns: bool,
        #[builder(default = 0.5)] vf_coef: f32,
        #[builder(default = 0.01)] ent_coef: f32,
        #[builder(default = 1024)] batch_size: usize,
        #[builder(default = 128)] mini_batch_size: usize,
        #[builder(default = 4)] num_epochs: usize,
        #[builder(default = 0.5)] gradient_clip: f32,
        training_horizon: usize,
        logging_info: Option<&'a mut dyn PPOLogger<I>>,
        device: candle_core::Device,
        #[builder(default = DType::F32)] dtype: DType,
    ) -> Result<Self, PPOConfigurationError> {
        if batch_size == 0 {
            return Err(PPOConfigurationError::ZeroBatchSize);
        }
        if mini_batch_size == 0 {
            return Err(PPOConfigurationError::ZeroMiniBatchSize);
        }
        if num_epochs == 0 {
            return Err(PPOConfigurationError::ZeroEpochs);
        }
        if training_horizon == 0 {
            return Err(PPOConfigurationError::ZeroTrainingHorizon);
        }
        if !gamma.is_finite() || !(0.0..=1.0).contains(&gamma) {
            return Err(PPOConfigurationError::InvalidGamma);
        }
        if !gae_lambda.is_finite() || !(0.0..=1.0).contains(&gae_lambda) {
            return Err(PPOConfigurationError::InvalidGaeLambda);
        }
        if !vf_coef.is_finite() || vf_coef < 0.0 {
            return Err(PPOConfigurationError::InvalidValueCoefficient);
        }
        if !ent_coef.is_finite() || ent_coef < 0.0 {
            return Err(PPOConfigurationError::InvalidEntropyCoefficient);
        }
        if !gradient_clip.is_finite() || gradient_clip <= 0.0 {
            return Err(PPOConfigurationError::InvalidGradientClip);
        }
        if !dtype.is_float() {
            return Err(PPOConfigurationError::InvalidDType);
        }

        Ok(Self {
            clipped,
            clip_value_loss,
            gamma,
            gae_lambda,
            clip_range,
            normalize_advantage,
            normalize_returns,
            vf_coef,
            ent_coef,
            network_info,
            action_space,
            rollout_buffer: RolloutBuffer::new(0, device), // placeholder, will set when we know num envs
            num_epochs,
            batch_size,
            schedule_progress: ScheduleProgress::new(training_horizon),
            mini_batch_size,
            logging_info: logging_info.map(PPOLoggingInfo::new),
            gradient_clip,
            current_states: None,
            episode_tracker: PPOEpisodeTracker::new(0),
            dtype,
            _phantom: PhantomData,
        })
    }
}

#[bon]
impl<'a, O1, O2, AE, GE, SE, I> PPOAgent<'a, O1, O2, AE, GE, SE, I>
where
    O1: Optimizer,
    O2: Optimizer,
    AE: std::fmt::Debug,
    GE: std::fmt::Debug,
    SE: std::fmt::Debug,
{
    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(name = "ppo.optimize", target = "modurl::performance", skip_all)
    )]
    fn optimize(&mut self) -> Result<(), PPOError<AE, GE, SE>> {
        let rollout_explained_variance = self.add_advantages_and_returns()?;

        let batch =
            <PPOExperience as experience::Experience>::batch(self.rollout_buffer.get_raw())?;
        let all_states = batch.states.flatten(0, 1)?;
        let all_actions = batch.actions.flatten(0, 1)?;
        let all_log_probs = batch.log_probs.flatten(0, 1)?;
        let prepared = batch.prepared.ok_or(PPOError::MissingPreparedRollout)?;
        let all_advantages = prepared.advantages.flatten(0, 1)?;
        let all_returns = prepared.returns.flatten(0, 1)?;
        let all_rewards = batch.rewards.flatten(0, 1)?;
        let all_old_values = prepared
            .old_values
            .map(|old_values| old_values.flatten(0, 1))
            .transpose()?;

        let total_samples = all_states.dims()[0];
        let device = all_states.device();
        let clip_range = self.schedule_progress.parameter(&*self.clip_range) as f32;

        for epoch in 0..self.num_epochs {
            if let Some(logging_info) = &mut self.logging_info {
                logging_info.epoch = epoch;
            }

            let mut indices: Vec<u32> = (0..total_samples as u32).collect();
            shuffle_with_device_rng(&mut indices, device)?;
            let indices_tensor = Tensor::from_vec(indices, &[total_samples], device)?;

            for start in (0..total_samples).step_by(self.mini_batch_size) {
                let end = (start + self.mini_batch_size).min(total_samples);
                let batch_size = end - start;

                let batch_indices = indices_tensor.narrow(0, start, batch_size)?;

                let batch_states = all_states.index_select(&batch_indices, 0)?;
                let batch_actions = all_actions.index_select(&batch_indices, 0)?;
                let batch_log_probs = all_log_probs.index_select(&batch_indices, 0)?;
                let batch_advantages = all_advantages.index_select(&batch_indices, 0)?;
                let batch_returns = all_returns.index_select(&batch_indices, 0)?;
                let batch_rewards = all_rewards.index_select(&batch_indices, 0)?;
                let batch_old_values = all_old_values
                    .as_ref()
                    .map(|old_values| old_values.index_select(&batch_indices, 0))
                    .transpose()?;

                let ppo_losses = self
                    .compute_loss()
                    .states(&batch_states)
                    .actions(&batch_actions)
                    .old_log_probs(batch_log_probs.detach())
                    .advantages(batch_advantages)
                    .returns(batch_returns)
                    .rewards(batch_rewards)
                    .maybe_old_values(batch_old_values.map(|old_values| old_values.detach()))
                    .explained_variance(rollout_explained_variance.clone())
                    .clip_range(clip_range)
                    .call()?;

                self.backpropagate_loss(ppo_losses.clone())?;
            }
        }

        self.rollout_buffer.clear();
        Ok(())
    }

    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(
            name = "ppo.prepare_rollout",
            target = "modurl::performance",
            level = "trace",
            skip_all
        )
    )]
    fn add_advantages_and_returns(&mut self) -> Result<Tensor, PPOError<AE, GE, SE>> {
        let batch =
            <PPOExperience as experience::Experience>::batch(self.rollout_buffer.get_raw())?;
        let states = batch.states;
        let (batch_size, env_count) = (states.dims()[0], states.dims()[1]);
        let states = states.flatten(0, 1)?;

        let latent_states = match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                shared_info.shared_network.forward(&states)?
            }
            PPONetworkInfo::Separate(ref mut _separate_info) => states,
        };

        let values_tensor = self.critic_network_forward(&latent_states)?.detach();

        // Unflatten back to [batch_size, env_count, ...].
        let values_tensor = values_tensor.reshape((batch_size, env_count, ()))?;

        let next_states_tensor = batch.next_states;
        let bootstrapped_states = next_states_tensor.i(next_states_tensor.shape().dims()[0] - 1)?; // shape [env_count, ...]
        let latent_bootstrapped_states = match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                shared_info.shared_network.forward(&bootstrapped_states)?
            }
            PPONetworkInfo::Separate(ref mut _separate_info) => bootstrapped_states,
        };

        let bootstrapped_values = self
            .critic_network_forward(&latent_bootstrapped_states)?
            .flatten_all()?
            .detach(); // shape [env_count]

        let advantages = self
            .compute_gae(
                &batch.training_rewards,
                &values_tensor,
                &batch.next_dones,
                &batch.truncateds,
                &bootstrapped_values,
            )?
            .detach();

        let values_tensor = values_tensor.squeeze(D::Minus1)?;

        let returns = (&values_tensor + &advantages)?;
        let rollout_explained_variance = compute_explained_variance(&returns, &values_tensor)?;

        let experiences = self.rollout_buffer.get_raw_mut();

        for (i, experience) in experiences.iter_mut().enumerate() {
            // The detaches here should be redundant but just to be safe
            experience.prepared = Some(PPOPreparedExperience {
                advantages: advantages.i(i)?.clone().detach(),
                returns: returns.i(i)?.clone().detach(),
                // values_tensor comes from the pre-update network, i.e. the
                // collection-time values PPO2 clips the new values against.
                old_values: if self.clip_value_loss {
                    Some(values_tensor.i(i)?.clone().detach())
                } else {
                    None
                },
            });
        }

        Ok(rollout_explained_variance)
    }

    /// Computes advantages `[time, env_count]` from rewards, values, done
    /// masks, and truncation masks with that same shape; `bootstrapped_values`
    /// is `[env_count]`.
    fn compute_gae(
        &self,
        rewards: &candle_core::Tensor,
        values: &candle_core::Tensor,
        next_dones: &candle_core::Tensor,
        next_truncateds: &candle_core::Tensor,
        bootstrapped_values: &candle_core::Tensor,
    ) -> Result<candle_core::Tensor, candle_core::Error> {
        let device = values.device();
        let rewards = rewards.to_dtype(self.dtype)?;
        let next_dones = next_dones.to_dtype(self.dtype)?;
        let next_truncateds = next_truncateds.to_dtype(self.dtype)?;
        let bootstrapped_values = bootstrapped_values.to_dtype(self.dtype)?;
        let gamma_tensor = Tensor::new(self.gamma, device)?.to_dtype(self.dtype)?;
        let gae_lambda_tensor = Tensor::new(self.gae_lambda, device)?.to_dtype(self.dtype)?;

        let values = values.squeeze(D::Minus1)?;
        let mut advantages = vec![];

        for env_idx in 0..rewards.shape().dims()[1] {
            let env_rewards = rewards.i((.., env_idx))?.detach();
            let env_next_dones = next_dones.i((.., env_idx))?.detach();
            let env_next_truncateds = next_truncateds.i((.., env_idx))?.detach();
            let env_values = values.i((.., env_idx))?.detach();
            let mut env_advantages = vec![];

            let mut next_value = bootstrapped_values.i(env_idx)?.detach();
            let mut gae = Tensor::zeros((), self.dtype, device)?;
            // Compute GAE backwards through the trajectory
            for i in (0..env_rewards.shape().dims()[0]).rev() {
                let same_episode =
                    ((1.0 - env_next_dones.i(i)?)? * (1.0 - env_next_truncateds.i(i)?)?)?;

                // TD error: δ = r + γ * V(s') - V(s)
                let delta = (env_rewards.i(i)?
                    + next_value.clone() * same_episode.clone() * gamma_tensor.clone()
                    - env_values.i(i)?)?;

                // GAE: A = δ + γ * λ * next_gae * (1 - next_done)
                gae = (delta
                    + gamma_tensor.clone() * gae_lambda_tensor.clone() * gae * same_episode)?;
                env_advantages.push(gae.clone());
                next_value = env_values.i(i)?;
            }

            // Reverse because our loop went backwards
            let env_advantages_tensor = Tensor::stack(
                &env_advantages.into_iter().rev().collect::<Vec<Tensor>>(),
                0,
            )?;
            advantages.push(env_advantages_tensor);
        }

        let advantages_tensor = Tensor::stack(&advantages, 1)?; // shape [time_steps, env_count]

        Ok(advantages_tensor)
    }

    /// Forwards latent or raw `states` shaped `[batch, ...state_shape]` and
    /// returns critic values shaped `[batch, 1]`.
    fn critic_network_forward(
        &mut self,
        states: &candle_core::Tensor,
    ) -> Result<candle_core::Tensor, PPOError<AE, GE, SE>> {
        match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                let values = shared_info.critic_head.forward(states)?;
                Ok(values)
            }
            PPONetworkInfo::Separate(ref mut separate_info) => {
                let values = separate_info.critic_network.forward(states)?;
                Ok(values)
            }
        }
    }

    /// Adds the bootstrap value for each truncated transition to its reward.
    /// GAE still stops at the truncation boundary, so the terminal value is
    /// included exactly once.
    /// `rewards` is `[environment_count]`, `transition_next_states` is
    /// `[environment_count, ...state_shape]`, and both boolean slices have
    /// `environment_count` entries. A true termination always suppresses
    /// bootstrapping, even if the transition is also truncated.
    fn bootstrap_truncated_rewards(
        &mut self,
        rewards: &Tensor,
        transition_next_states: &Tensor,
        dones: &[bool],
        truncateds: &[bool],
    ) -> Result<Tensor, PPOError<AE, GE, SE>> {
        if dones.len() != truncateds.len() {
            return Err(PPOError::MismatchedTerminationBatch {
                dones: dones.len(),
                truncateds: truncateds.len(),
            });
        }
        let truncated_indices = truncateds
            .iter()
            .zip(dones)
            .enumerate()
            .filter_map(|(index, (truncated, done))| (*truncated && !*done).then_some(index as u32))
            .collect::<Vec<_>>();
        if truncated_indices.is_empty() {
            return Ok(rewards.to_dtype(self.dtype)?);
        }

        let truncation_count = truncated_indices.len();
        let truncated_indices = Tensor::from_vec(
            truncated_indices,
            truncation_count,
            transition_next_states.device(),
        )?;
        let truncated_next_states = transition_next_states.index_select(&truncated_indices, 0)?;

        let latent_states = match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                shared_info.shared_network.forward(&truncated_next_states)?
            }
            PPONetworkInfo::Separate(_) => truncated_next_states,
        };
        let terminal_values = self
            .critic_network_forward(&latent_states)?
            .flatten_all()?
            .detach();
        let terminal_bootstrap = (terminal_values.to_dtype(self.dtype)? * self.gamma as f64)?;
        Ok(rewards
            .to_dtype(self.dtype)?
            .index_add(&truncated_indices, &terminal_bootstrap, 0)?)
    }

    /// Evaluates `actions` `[batch, ...action_shape]` for latent or raw
    /// `states` `[batch, ...state_shape]`, returning two `[batch]` tensors.
    fn actor_network_log_prob_and_entropy(
        &mut self,
        states: &candle_core::Tensor,
        actions: &candle_core::Tensor,
    ) -> Result<(candle_core::Tensor, candle_core::Tensor), PPOError<AE, GE, SE>> {
        match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                let (log_probs, entropy) = shared_info
                    .actor_head
                    .log_prob_and_entropy(states, actions)
                    .map_err(PPOError::PolicyError)?;
                Ok((log_probs, entropy))
            }
            PPONetworkInfo::Separate(ref mut separate_info) => {
                let (log_probs, entropy) = separate_info
                    .actor_network
                    .log_prob_and_entropy(states, actions)
                    .map_err(PPOError::PolicyError)?;
                Ok((log_probs, entropy))
            }
        }
    }

    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(
            name = "ppo.compute_loss",
            target = "modurl::performance",
            level = "trace",
            skip_all
        )
    )]
    #[builder]
    /// Computes losses from `states` `[batch, ...state_shape]`, `actions`
    /// `[batch, ...action_shape]`, and vector statistics (`old_log_probs`,
    /// `advantages`, `returns`, and `rewards`) shaped `[batch]`. `old_values`
    /// is present only when value-loss clipping is enabled.
    /// `explained_variance` is scalar `[]`.
    fn compute_loss(
        &mut self,
        states: &candle_core::Tensor,
        actions: &candle_core::Tensor,
        old_log_probs: candle_core::Tensor,
        advantages: candle_core::Tensor,
        returns: candle_core::Tensor,
        rewards: candle_core::Tensor,
        old_values: Option<candle_core::Tensor>,
        explained_variance: candle_core::Tensor,
        clip_range: f32,
    ) -> Result<PPOLosses, PPOError<AE, GE, SE>> {
        let advantages = if self.normalize_advantage {
            normalize_tensor(&advantages)?
        } else {
            advantages
        }
        .detach();

        // if the networks are shared, we need to extract the latent state
        // if it's separate we just say this is the state as is
        let latent_state = match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                shared_info.shared_network.forward(states)?
            }
            PPONetworkInfo::Separate(ref mut _separate_info) => states.clone(),
        };

        let (log_probs, entropy) =
            self.actor_network_log_prob_and_entropy(&latent_state, actions)?;

        let log_ratio = (&log_probs - &old_log_probs)?;
        let ratio = log_ratio.exp()?;
        let approx_kl = ((&ratio - 1.0)? - &log_ratio)?;

        let actor_loss = match self.clipped {
            true => {
                let clipped_ratio = ratio.clamp(1.0 - clip_range, 1.0 + clip_range)?;

                let surrogate1 = (ratio.clone() * advantages.clone())?;
                let surrogate2 = (clipped_ratio.clone() * advantages.clone())?;
                let surrogate = surrogate1.minimum(&surrogate2)?;

                (-1.0 * surrogate.mean_all()?)?
            }
            false => {
                let surrogate = (ratio.clone() * &advantages)?;
                (-1.0 * surrogate.mean_all()?)?
            }
        };

        let values = self.critic_network_forward(&latent_state)?;
        let values = values.squeeze(D::Minus1)?;

        let entropy_loss = entropy.mean_all()?;

        let final_actor_loss =
            (actor_loss.clone() - ((self.ent_coef as f64) * entropy_loss.clone()))?;

        let returns = returns.detach();
        let returns = if self.normalize_returns {
            normalize_tensor(&returns)?
        } else {
            returns
        }
        .detach();

        let critic_loss = if self.clip_value_loss {
            // PPO2/CleanRL value-loss clipping: bound how far the value estimate
            // may move from its rollout-time value within one update.
            let old_values = old_values.ok_or(PPOError::MissingOldValues)?;
            clipped_value_loss(&values, &returns, &old_values, clip_range as f64)?
        } else {
            loss::mse(&values, &returns)?
        };
        // Match SB3 PPO: value_loss = vf_coef * mean_squared_error.
        let final_critic_loss = ((self.vf_coef as f64) * critic_loss)?;

        if let Some(logging_info) = &mut self.logging_info {
            let log_entry = PPOLogEntry {
                actor_loss: final_actor_loss.clone(),
                critic_loss: final_critic_loss.clone(),
                entropy: entropy_loss,
                kl_divergence: approx_kl,
                explained_variance,
                rewards,
                epoch: logging_info.epoch,
                timestep: logging_info.timestep,
                returns,
                advantages,
            };
            logging_info.logger.log(&log_entry);
        }

        Ok(PPOLosses {
            actor_loss: final_actor_loss,
            critic_loss: final_critic_loss,
        })
    }

    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(
            name = "ppo.backpropagate",
            target = "modurl::performance",
            level = "trace",
            skip_all
        )
    )]
    fn backpropagate_loss(&mut self, losses: PPOLosses) -> Result<(), PPOError<AE, GE, SE>> {
        let actor_loss = losses.actor_loss;
        let critic_loss = losses.critic_loss;

        match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                let total_loss = (&actor_loss + &critic_loss)?;
                let total_grad = &mut total_loss.backward()?;
                let _total_grad_norm = crate::tensor_operations::clip_gradients(
                    &total_loss,
                    total_grad,
                    self.gradient_clip,
                )?;
                shared_info.optimizer.step(total_grad)?;
            }
            PPONetworkInfo::Separate(ref mut separate_info) => match separate_info.combined_loss {
                true => {
                    let total_loss = (&actor_loss + &critic_loss)?;
                    let total_grad = &mut total_loss.backward()?;
                    let _total_grad_norm = crate::tensor_operations::clip_gradients(
                        &total_loss,
                        total_grad,
                        self.gradient_clip,
                    )?;
                    separate_info.actor_optimizer.step(total_grad)?;
                    separate_info.critic_optimizer.step(total_grad)?;
                }
                false => {
                    let actor_grad = &mut actor_loss.backward()?;
                    let _actor_grad_norm = crate::tensor_operations::clip_gradients(
                        &actor_loss,
                        actor_grad,
                        self.gradient_clip,
                    )?;
                    separate_info.actor_optimizer.step(actor_grad)?;

                    let critic_grad = &mut critic_loss.backward()?;
                    let _critic_grad_norm = crate::tensor_operations::clip_gradients(
                        &critic_loss,
                        critic_grad,
                        self.gradient_clip,
                    )?;
                    separate_info.critic_optimizer.step(critic_grad)?;
                }
            },
        }

        Ok(())
    }

    /// Samples latent actions `[batch, ...action_shape]` for latent or raw
    /// `states` `[batch, ...state_shape]`.
    fn act_neurons(
        &mut self,
        states: &candle_core::Tensor,
    ) -> Result<candle_core::Tensor, PPOError<AE, GE, SE>> {
        let network = match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => &shared_info.actor_head,
            PPONetworkInfo::Separate(ref mut separate_info) => &separate_info.actor_network,
        };

        network.sample(states).map_err(PPOError::PolicyError)
    }

    /// Samples policy actions for `states` shaped
    /// `[environment_count, ...observation_shape]`.
    fn sample_collection_action(
        &mut self,
        states: &Tensor,
    ) -> Result<PPOCollectionAction, PPOError<AE, GE, SE>> {
        let latent_states = match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                shared_info.shared_network.forward(states)?
            }
            PPONetworkInfo::Separate(_) => states.clone(),
        };
        let policy_actions = self.act_neurons(&latent_states)?;
        let environment_actions = self
            .action_space
            .tensor_from_neurons(&policy_actions)
            .map_err(PPOError::SpaceError)?;
        let (log_probs, _) =
            self.actor_network_log_prob_and_entropy(&latent_states, &policy_actions)?;
        Ok(PPOCollectionAction {
            policy_actions,
            environment_actions,
            // Do not retain the collection forward graph in the rollout buffer.
            log_probs: log_probs.detach(),
        })
    }

    fn update_learning_rates(&mut self) {
        match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                if let Some(lr_scheduler) = &shared_info.lr_scheduler {
                    let new_lr = self.schedule_progress.parameter(&**lr_scheduler);
                    shared_info.optimizer.set_learning_rate(new_lr);
                }
            }
            PPONetworkInfo::Separate(ref mut separate_info) => {
                if let Some(actor_lr_scheduler) = &separate_info.actor_lr_scheduler {
                    let new_lr = self.schedule_progress.parameter(&**actor_lr_scheduler);
                    separate_info.actor_optimizer.set_learning_rate(new_lr);
                }
                if let Some(critic_lr_scheduler) = &separate_info.critic_lr_scheduler {
                    let new_lr = self.schedule_progress.parameter(&**critic_lr_scheduler);
                    separate_info.critic_optimizer.set_learning_rate(new_lr);
                }
            }
        }
    }

    /// Logs vectorized `rewards` shaped `[env_count]` alongside one metadata
    /// and termination entry per environment.
    fn log_collection(
        &mut self,
        rewards: &Tensor,
        infos: Vec<I>,
        dones: &[bool],
        truncateds: &[bool],
        first_collection_timestep: usize,
    ) -> Result<(), candle_core::Error> {
        let Some(logging_info) = &mut self.logging_info else {
            return Ok(());
        };

        let rewards_vec = rewards.to_vec1::<f32>()?;
        let mut completed_episodes = Vec::new();
        for (environment_index, reward) in rewards_vec.iter().copied().enumerate() {
            let collection_timestep =
                first_collection_timestep.saturating_add(environment_index + 1);
            if let Some(entry) = self.episode_tracker.record(
                environment_index,
                reward,
                dones[environment_index],
                truncateds[environment_index],
                collection_timestep,
            ) {
                completed_episodes.push(entry);
            }
        }

        logging_info.logger.log_collection(&PPOCollectionLogEntry {
            collection_rewards: rewards.clone(),
            infos,
            collection_timestep: first_collection_timestep.saturating_add(rewards_vec.len()),
            completed_episodes,
        });
        Ok(())
    }

    pub fn set_learning_rate(&mut self, lr: f64) {
        match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                shared_info.optimizer.set_learning_rate(lr);
            }
            PPONetworkInfo::Separate(ref mut separate_info) => {
                separate_info.actor_optimizer.set_learning_rate(lr);
                separate_info.critic_optimizer.set_learning_rate(lr);
            }
        }
    }

    /// Selects the policy distribution's mode without sampling.
    ///
    /// This is intended for deterministic evaluation. PPO rollouts remain
    /// stochastic and continue to use [`Agent::act`]. `observation` is shaped
    /// `[batch, ...observation_shape]`; the returned environment action is
    /// `[batch, ...action_shape]`.
    pub fn act_deterministic(
        &mut self,
        observation: &Tensor,
    ) -> Result<Tensor, PPOError<AE, GE, SE>> {
        let observation = observation.to_dtype(self.dtype)?;
        let latent_states = match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                shared_info.shared_network.forward(&observation)?
            }
            PPONetworkInfo::Separate(_) => observation,
        };
        let network = match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => &shared_info.actor_head,
            PPONetworkInfo::Separate(ref mut separate_info) => &separate_info.actor_network,
        };
        let neurons = network
            .mode(&latent_states)
            .map_err(PPOError::PolicyError)?;
        self.action_space
            .tensor_from_neurons(&neurons)
            .map_err(PPOError::SpaceError)
    }

    pub fn reset_current_states(&mut self) {
        self.current_states = None;
        self.episode_tracker.clear();
    }

    /// Prepares an empty rollout buffer and episode tracking, returning the
    /// observations shaped `[environment_count, ...observation_shape]` from
    /// which collection should resume.
    fn prepare_rollout_collection(
        &mut self,
        env: &mut dyn MultiGym<I, Error = GE, SpaceError = SE>,
    ) -> Result<Tensor, PPOError<AE, GE, SE>> {
        let states = if let Some(states) = self.current_states.take() {
            states
        } else {
            env.reset().map_err(PPOError::GymError)?
        }
        .to_dtype(self.dtype)?;
        let environment_count = env.num_envs();
        if environment_count == 0 {
            return Err(PPOConfigurationError::ZeroEnvironments.into());
        }
        if !self.batch_size.is_multiple_of(environment_count) {
            return Err(PPOConfigurationError::BatchNotDivisibleByEnvironmentCount.into());
        }
        self.rollout_buffer = RolloutBuffer::new(
            self.mini_batch_size / environment_count,
            states.device().clone(),
        );
        if self.logging_info.is_some()
            && self.episode_tracker.environment_count() != environment_count
        {
            self.episode_tracker = PPOEpisodeTracker::new(environment_count);
        }
        Ok(states)
    }

    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(
            name = "ppo.collect_rollout",
            target = "modurl::performance",
            skip_all
        )
    )]
    /// Fills the rollout buffer, updating `next_states` shaped
    /// `[environment_count, ...observation_shape]` after each environment step.
    fn collect_rollout(
        &mut self,
        env: &mut dyn MultiGym<I, Error = GE, SpaceError = SE>,
        next_states: &mut Tensor,
    ) -> Result<usize, PPOError<AE, GE, SE>> {
        let environment_count = env.num_envs();
        while self.rollout_buffer.len() * environment_count < self.batch_size {
            let states = next_states.clone();
            let collection_action = self.sample_collection_action(&states)?;
            let step_info = env
                .step(collection_action.environment_actions.clone())
                .map_err(PPOError::GymError)?;
            let training_next_states = step_info.transition_next_states()?.to_dtype(self.dtype)?;
            let MultiGymStepInfo {
                states: reset_or_next_states,
                rewards: collection_rewards,
                infos,
                dones: next_dones,
                truncateds,
                terminal_states: _,
            } = step_info;
            let first_collection_timestep = self
                .schedule_progress
                .elapsed_steps()
                .saturating_add(self.rollout_buffer.len() * environment_count);
            self.log_collection(
                &collection_rewards,
                infos,
                &next_dones,
                &truncateds,
                first_collection_timestep,
            )?;
            let training_rewards = self.bootstrap_truncated_rewards(
                &collection_rewards,
                &training_next_states,
                &next_dones,
                &truncateds,
            )?;
            self.rollout_buffer.add(
                PPOExperience::builder()
                    .states(states)
                    .next_states(training_next_states)
                    .actions(collection_action.policy_actions.detach())
                    .rewards(collection_rewards)
                    .training_rewards(training_rewards)
                    .next_dones(next_dones)
                    .truncateds(truncateds)
                    .log_probs(collection_action.log_probs)
                    .build(),
            );
            *next_states = reset_or_next_states.to_dtype(self.dtype)?;
        }

        Ok(self.rollout_buffer.len() * environment_count)
    }

    fn train_on_collected_rollout(
        &mut self,
        collected_timesteps: usize,
    ) -> Result<(), PPOError<AE, GE, SE>> {
        self.schedule_progress.advance_steps(collected_timesteps);
        self.update_learning_rates();
        if let Some(logging_info) = &mut self.logging_info {
            logging_info.timestep = self.schedule_progress.elapsed_steps();
        }
        self.optimize()
    }
}

impl<'a, O1, O2, AE, GE, SE, I> Agent<I> for PPOAgent<'a, O1, O2, AE, GE, SE, I>
where
    O1: Optimizer,
    O2: Optimizer,
    AE: std::fmt::Debug,
    GE: std::fmt::Debug,
    SE: std::fmt::Debug,
{
    type Error = PPOError<AE, GE, SE>;
    type GymError = GE;
    type SpaceError = SE;

    /// Selects environment actions `[batch, ...action_shape]` for observations
    /// `[batch, ...observation_shape]`.
    fn act(&mut self, observation: &Tensor) -> Result<Tensor, Self::Error> {
        let observation = observation.to_dtype(self.dtype)?;
        let latent_states = match self.network_info {
            PPONetworkInfo::Shared(ref mut shared_info) => {
                shared_info.shared_network.forward(&observation)?
            }
            PPONetworkInfo::Separate(ref mut _separate_info) => observation,
        };
        let neurons = self.act_neurons(&latent_states)?;
        let actions = self
            .action_space
            .tensor_from_neurons(&neurons)
            .map_err(PPOError::SpaceError)?;
        Ok(actions)
    }

    #[cfg_attr(
        feature = "tracing",
        tracing::instrument(
            name = "ppo.learn",
            target = "modurl::performance",
            skip_all,
            fields(num_timesteps)
        )
    )]
    fn learn(
        &mut self,
        env: &mut dyn MultiGym<I, Error = Self::GymError, SpaceError = Self::SpaceError>,
        num_timesteps: usize,
    ) -> Result<(), PPOError<AE, GE, SE>> {
        let mut elapsed_timesteps = 0;
        let mut next_states = self.prepare_rollout_collection(env)?;

        while elapsed_timesteps < num_timesteps {
            let collected_timesteps = self.collect_rollout(env, &mut next_states)?;
            elapsed_timesteps += collected_timesteps;
            self.train_on_collected_rollout(collected_timesteps)?;
        }
        self.current_states = Some(next_states);
        Ok(())
    }
}

#[cfg(test)]
mod schedule_tests {
    use std::collections::HashSet;

    use candle_core::{DType, Device, TensorId, Var};
    use candle_nn::{Optimizer, VarBuilder, VarMap};

    use super::*;
    use crate::{
        agents::{
            Agent,
            test_support::{CountingOptimizer, FixedEnv},
        },
        distributions::{CategoricalDistribution, GaussianDistribution},
        gym::{Gym, MultiGym, ResetInfo, StepInfo, VectorizedGymWrapper},
        models::{
            MLP,
            probabilistic_model::{ProbabilisticPolicyModel, ProbabilisticPolicyModelError},
        },
        parameter_schedule::LinearSchedule,
        spaces::{BoxSpace, Discrete, Space},
    };

    fn assert_close(actual: f64, expected: f64) {
        assert!(
            (actual - expected).abs() < 1e-12,
            "expected {expected}, got {actual}"
        );
    }

    struct NoopLogger;

    impl PPOLogger for NoopLogger {
        fn log(&mut self, _info: &PPOLogEntry) {}
    }

    #[test]
    fn candle_elementwise_minimum_and_maximum_split_tied_gradients() {
        /// Checks scalar `loss` shaped `[1]` made from tied scalar variables.
        fn assert_tied_gradients(loss: Tensor, left: &Var, right: &Var) {
            let gradients = loss.sum_all().unwrap().backward().unwrap();
            for variable in [left, right] {
                assert_eq!(
                    gradients
                        .get(variable.as_tensor())
                        .unwrap()
                        .to_vec1::<f32>()
                        .unwrap(),
                    vec![0.5]
                );
            }
        }

        for maximum in [false, true] {
            let left = Var::from_vec(vec![1.0_f32], 1, &Device::Cpu).unwrap();
            let right = Var::from_vec(vec![1.0_f32], 1, &Device::Cpu).unwrap();
            let loss = if maximum {
                left.as_tensor().maximum(right.as_tensor()).unwrap()
            } else {
                left.as_tensor().minimum(right.as_tensor()).unwrap()
            };
            assert_tied_gradients(loss, &left, &right);
        }
    }

    struct TwoStepTestGym {
        device: Device,
        steps: usize,
        truncates: bool,
    }

    impl TwoStepTestGym {
        fn new(device: Device, truncates: bool) -> Self {
            Self {
                device,
                steps: 0,
                truncates,
            }
        }
    }

    impl Gym<usize> for TwoStepTestGym {
        type Error = candle_core::Error;
        type SpaceError = candle_core::Error;

        /// Steps with one scalar discrete action shaped `[]`.
        fn step(&mut self, _action: Tensor) -> Result<StepInfo<usize>, Self::Error> {
            self.steps += 1;
            Ok(StepInfo {
                state: Tensor::zeros(4, DType::F32, &self.device)?,
                reward: 1.0,
                done: self.steps == 2 && !self.truncates,
                truncated: self.steps == 2 && self.truncates,
                info: self.steps,
            })
        }

        fn reset(&mut self) -> Result<ResetInfo<usize>, Self::Error> {
            self.steps = 0;
            Ok(ResetInfo {
                state: Tensor::zeros(4, DType::F32, &self.device)?,
                info: 0,
            })
        }

        fn observation_space(&self) -> Box<dyn Space<Error = Self::SpaceError>> {
            Box::new(BoxSpace::new_with_universal_bounds(
                vec![4],
                -1.0,
                1.0,
                &self.device,
            ))
        }

        fn action_space(&self) -> Box<dyn Space<Error = Self::SpaceError>> {
            Box::new(Discrete::new(2))
        }
    }

    #[test]
    fn explained_variance_uses_population_variance() {
        let device = Device::Cpu;
        let returns = Tensor::from_vec(vec![1.0f32, 2.0, 3.0], 3, &device).unwrap();
        let rollout_values = Tensor::from_vec(vec![1.0f32, 2.0, 2.0], 3, &device).unwrap();

        let actual = compute_explained_variance(&returns, &rollout_values)
            .unwrap()
            .to_vec0::<f32>()
            .unwrap();

        assert!((actual - 2.0 / 3.0).abs() < 1e-6);
    }

    #[test]
    fn explained_variance_is_nan_for_constant_returns() {
        let device = Device::Cpu;
        let returns = Tensor::from_vec(vec![1.0f32, 1.0, 1.0], 3, &device).unwrap();
        let rollout_values = Tensor::from_vec(vec![0.0f32, 1.0, 2.0], 3, &device).unwrap();

        let actual = compute_explained_variance(&returns, &rollout_values)
            .unwrap()
            .to_vec0::<f32>()
            .unwrap();

        assert!(actual.is_nan());
    }

    #[test]
    fn simultaneous_termination_and_truncation_does_not_bootstrap() {
        struct UnitCritic;

        impl candle_core::Module for UnitCritic {
            /// Returns one value prediction per input row, shaped `[batch, 1]`.
            fn forward(&self, input: &Tensor) -> candle_core::Result<Tensor> {
                Tensor::ones((input.dim(0)?, 1), input.dtype(), input.device())
            }
        }

        let device = Device::Cpu;
        let actor_vars = VarMap::new();
        let actor = MLP::builder()
            .input_size(4)
            .output_size(2)
            .vb(VarBuilder::from_varmap(&actor_vars, DType::F32, &device))
            .build()
            .unwrap();
        let networks = PPONetworkInfo::Separate(
            SeparatePPONetwork::builder()
                .actor_optimizer(CountingOptimizer::with_learning_rate(1e-3))
                .critic_optimizer(CountingOptimizer::with_learning_rate(1e-3))
                .actor_network(ProbabilisticPolicyModel::<CategoricalDistribution>::new(
                    actor,
                ))
                .critic_network(UnitCritic)
                .build(),
        );
        let mut agent: PPOAgent<
            '_,
            CountingOptimizer,
            CountingOptimizer,
            ProbabilisticPolicyModelError<crate::distributions::CategoricalDistributionError>,
            candle_core::Error,
            candle_core::Error,
        > = PPOAgent::builder()
            .action_space(Box::new(Discrete::new(2)))
            .network_info(networks)
            .batch_size(2)
            .mini_batch_size(2)
            .training_horizon(2)
            .device(device.clone())
            .build()
            .unwrap();
        let rewards = Tensor::from_vec(vec![1.0_f32, 2.0], 2, &device).unwrap();
        let next_states = Tensor::zeros((2, 4), DType::F32, &device).unwrap();

        let actual = agent
            .bootstrap_truncated_rewards(&rewards, &next_states, &[true, false], &[true, true])
            .unwrap()
            .to_vec1::<f32>()
            .unwrap();

        assert_eq!(actual, vec![1.0, 2.99]);
    }

    #[test]
    fn collection_logs_report_fresh_rewards_and_completed_episodes() {
        let device = Device::Cpu;
        let mut env: VectorizedGymWrapper<TwoStepTestGym, usize> = vec![
            TwoStepTestGym::new(device.clone(), false),
            TwoStepTestGym::new(device.clone(), true),
        ]
        .into();
        let actor_vars = VarMap::new();
        let critic_vars = VarMap::new();
        let actor = MLP::builder()
            .input_size(4)
            .output_size(2)
            .vb(VarBuilder::from_varmap(&actor_vars, DType::F32, &device))
            .hidden_layer_sizes(vec![2])
            .build()
            .unwrap();
        let critic = MLP::builder()
            .input_size(4)
            .output_size(1)
            .vb(VarBuilder::from_varmap(&critic_vars, DType::F32, &device))
            .hidden_layer_sizes(vec![2])
            .build()
            .unwrap();
        let networks = PPONetworkInfo::Separate(
            SeparatePPONetwork::builder()
                .actor_optimizer(CountingOptimizer::with_learning_rate(1e-3))
                .critic_optimizer(CountingOptimizer::with_learning_rate(1e-3))
                .actor_network(ProbabilisticPolicyModel::<CategoricalDistribution>::new(
                    actor,
                ))
                .critic_network(critic)
                .build(),
        );

        struct CollectionLogger {
            collection_rewards: Vec<Vec<f32>>,
            optimization_rewards: Vec<Vec<f32>>,
            infos: Vec<Vec<usize>>,
            completed_episodes: Vec<(usize, f32, usize, bool, bool, usize)>,
        }

        impl PPOLogger<usize> for CollectionLogger {
            fn log(&mut self, entry: &PPOLogEntry) {
                self.optimization_rewards
                    .push(entry.rewards.to_vec1::<f32>().unwrap());
            }

            fn log_collection(&mut self, entry: &PPOCollectionLogEntry<usize>) {
                self.collection_rewards
                    .push(entry.collection_rewards.to_vec1::<f32>().unwrap());
                self.infos.push(entry.infos.clone());
                self.completed_episodes
                    .extend(entry.completed_episodes.iter().map(|episode| {
                        (
                            episode.environment_index,
                            episode.episode_return,
                            episode.episode_length,
                            episode.terminated,
                            episode.truncated,
                            episode.collection_timestep,
                        )
                    }));
            }
        }

        let mut logger = CollectionLogger {
            collection_rewards: Vec::new(),
            optimization_rewards: Vec::new(),
            infos: Vec::new(),
            completed_episodes: Vec::new(),
        };
        let mut agent = PPOAgent::builder()
            .action_space(env.action_space())
            .network_info(networks)
            .batch_size(2)
            .mini_batch_size(2)
            .num_epochs(1)
            .training_horizon(4)
            .logging_info(&mut logger)
            .device(device)
            .build()
            .unwrap();

        agent.learn(&mut env, 2).unwrap();
        agent.learn(&mut env, 2).unwrap();

        assert_eq!(
            logger.collection_rewards,
            vec![vec![1.0, 1.0], vec![1.0, 1.0]]
        );
        assert_eq!(
            logger.optimization_rewards,
            vec![vec![1.0, 1.0], vec![1.0, 1.0]]
        );
        assert_eq!(logger.infos, vec![vec![1, 1], vec![2, 2]]);
        assert_eq!(
            logger.completed_episodes,
            vec![(0, 2.0, 2, true, false, 3), (1, 2.0, 2, false, true, 4)]
        );
    }

    #[test]
    fn shared_agent_runs_collection_training_actions_and_state_reset() {
        let device = Device::Cpu;
        let mut env: VectorizedGymWrapper<FixedEnv> =
            vec![FixedEnv::new(device.clone()), FixedEnv::new(device.clone())].into();
        let shared_vars = VarMap::new();
        let actor_vars = VarMap::new();
        let critic_vars = VarMap::new();
        let shared_network = MLP::builder()
            .input_size(4)
            .output_size(4)
            .vb(VarBuilder::from_varmap(&shared_vars, DType::F32, &device))
            .hidden_layer_sizes(vec![4])
            .build()
            .unwrap();
        let actor_head = MLP::builder()
            .input_size(4)
            .output_size(2)
            .vb(VarBuilder::from_varmap(&actor_vars, DType::F32, &device))
            .hidden_layer_sizes(vec![2])
            .build()
            .unwrap();
        let critic_head = MLP::builder()
            .input_size(4)
            .output_size(1)
            .vb(VarBuilder::from_varmap(&critic_vars, DType::F32, &device))
            .hidden_layer_sizes(vec![2])
            .build()
            .unwrap();
        let network_info: PPONetworkInfo<CountingOptimizer, _, FakeOptimizer> =
            PPONetworkInfo::Shared(
                SharedPPONetwork::builder()
                    .optimizer(CountingOptimizer::with_learning_rate(1e-3))
                    .shared_network(shared_network)
                    .actor_head(ProbabilisticPolicyModel::<CategoricalDistribution>::new(
                        actor_head,
                    ))
                    .critic_head(critic_head)
                    .lr_scheduler(LinearSchedule::new(1e-3, 1e-4))
                    .build(),
            );
        let mut logger = NoopLogger;
        let mut agent = PPOAgent::builder()
            .action_space(env.action_space())
            .network_info(network_info)
            .batch_size(2)
            .mini_batch_size(2)
            .num_epochs(1)
            .training_horizon(10)
            .logging_info(&mut logger)
            .device(device.clone())
            .build()
            .unwrap();

        agent.learn(&mut env, 2).unwrap();
        let observations = agent.current_states.as_ref().unwrap().clone();
        assert_eq!(agent.act(&observations).unwrap().dims(), &[2]);
        assert_eq!(agent.act_deterministic(&observations).unwrap().dims(), &[2]);
        assert_eq!(agent.episode_tracker.environment_count(), 2);
        let PPONetworkInfo::Shared(network) = &agent.network_info else {
            panic!("expected shared PPO network");
        };
        assert_eq!(network.optimizer.steps, 1);
        assert_close(network.optimizer.learning_rate(), 0.00082);

        agent.set_learning_rate(0.25);
        let PPONetworkInfo::Shared(network) = &agent.network_info else {
            panic!("expected shared PPO network");
        };
        assert_close(network.optimizer.learning_rate(), 0.25);

        agent.reset_current_states();
        assert!(agent.current_states.is_none());
        assert_eq!(agent.episode_tracker.environment_count(), 0);
    }

    #[test]
    fn separate_ppo_losses_only_reach_their_parameters() {
        fn parameter_ids(vars: &[Var]) -> HashSet<TensorId> {
            vars.iter().map(|var| var.as_tensor().id()).collect()
        }

        fn gradient_ids(gradients: &candle_core::backprop::GradStore) -> HashSet<TensorId> {
            gradients.get_ids().copied().collect()
        }

        let device = Device::Cpu;
        let actor_var_map = VarMap::new();
        let critic_var_map = VarMap::new();
        let actor_network = MLP::builder()
            .input_size(4)
            .output_size(6)
            .vb(VarBuilder::from_varmap(&actor_var_map, DType::F32, &device))
            .activation(Tensor::tanh)
            .hidden_layer_sizes(vec![8])
            .build()
            .unwrap();
        let critic_network = MLP::builder()
            .input_size(4)
            .output_size(1)
            .vb(VarBuilder::from_varmap(
                &critic_var_map,
                DType::F32,
                &device,
            ))
            .activation(Tensor::tanh)
            .hidden_layer_sizes(vec![8])
            .build()
            .unwrap();
        let actor_parameters = actor_var_map.all_vars();
        let critic_parameters = critic_var_map.all_vars();
        let actor_ids = parameter_ids(&actor_parameters);
        let critic_ids = parameter_ids(&critic_parameters);
        let expected_combined_ids = actor_ids
            .union(&critic_ids)
            .copied()
            .collect::<HashSet<_>>();

        let network_info = PPONetworkInfo::Separate(
            SeparatePPONetwork::builder()
                .actor_optimizer(CountingOptimizer::with_learning_rate(3e-4))
                .critic_optimizer(CountingOptimizer::with_learning_rate(3e-4))
                .actor_network(ProbabilisticPolicyModel::<GaussianDistribution>::new(
                    actor_network,
                ))
                .critic_network(critic_network)
                .combined_loss(true)
                .build(),
        );
        let mut agent: PPOAgent<
            '_,
            CountingOptimizer,
            CountingOptimizer,
            ProbabilisticPolicyModelError<crate::distributions::GaussianDistributionError>,
            candle_core::Error,
            candle_core::Error,
        > = PPOAgent::builder()
            .action_space(Box::new(BoxSpace::new_with_universal_bounds(
                vec![3],
                -1.0,
                1.0,
                &device,
            )))
            .network_info(network_info)
            .batch_size(4)
            .mini_batch_size(4)
            .ent_coef(0.001)
            .clip_value_loss(true)
            .training_horizon(4)
            .device(device.clone())
            .build()
            .unwrap();

        // Model rollout data as variables, then detach every field at the same
        // boundaries used by optimize(). None of these IDs may survive in the
        // loss gradient store.
        let rollout_states = Var::from_vec(
            vec![
                0.1f32, 0.2, 0.3, 0.4, -0.1, 0.3, -0.2, 0.5, 0.7, -0.4, 0.2, -0.3, -0.5, -0.2, 0.6,
                0.1,
            ],
            (4, 4),
            &device,
        )
        .unwrap();
        let rollout_actions = Var::from_vec(vec![0.1f32; 12], (4, 3), &device).unwrap();
        let rollout_log_probs = Var::from_vec(vec![-1.0f32; 4], 4, &device).unwrap();
        let rollout_advantages = Var::from_vec(vec![1.0f32, -1.0, 0.5, -0.5], 4, &device).unwrap();
        let rollout_returns = Var::from_vec(vec![1.0f32, 2.0, 3.0, 4.0], 4, &device).unwrap();
        let rollout_rewards = Var::from_vec(vec![0.1f32; 4], 4, &device).unwrap();
        let rollout_old_values = Var::from_vec(vec![0.0f32; 4], 4, &device).unwrap();
        let rollout_ids = parameter_ids(&[
            rollout_states.clone(),
            rollout_actions.clone(),
            rollout_log_probs.clone(),
            rollout_advantages.clone(),
            rollout_returns.clone(),
            rollout_rewards.clone(),
            rollout_old_values.clone(),
        ]);

        let losses = agent
            .compute_loss()
            .states(&rollout_states.detach())
            .actions(&rollout_actions.detach())
            .old_log_probs(rollout_log_probs.detach())
            .advantages(rollout_advantages.detach())
            .returns(rollout_returns.detach())
            .rewards(rollout_rewards.detach())
            .old_values(rollout_old_values.detach())
            .explained_variance(Tensor::new(0.0f32, &device).unwrap())
            .clip_range(0.2)
            .call()
            .unwrap();

        let actor_gradients = losses.actor_loss.backward().unwrap();
        let critic_gradients = losses.critic_loss.backward().unwrap();
        let combined_gradients = (&losses.actor_loss + &losses.critic_loss)
            .unwrap()
            .backward()
            .unwrap();

        let actor_gradient_ids = gradient_ids(&actor_gradients);
        let critic_gradient_ids = gradient_ids(&critic_gradients);
        let combined_gradient_ids = gradient_ids(&combined_gradients);

        // Candle also retains local gradients for some non-variable operands.
        // Optimizers only query registered variable IDs, so audit the variable
        // boundaries rather than requiring the GradStore to contain only
        // parameter entries.
        assert!(actor_ids.is_subset(&actor_gradient_ids));
        assert!(actor_gradient_ids.is_disjoint(&critic_ids));
        assert!(actor_gradient_ids.is_disjoint(&rollout_ids));
        assert!(critic_ids.is_subset(&critic_gradient_ids));
        assert!(critic_gradient_ids.is_disjoint(&actor_ids));
        assert!(critic_gradient_ids.is_disjoint(&rollout_ids));
        assert!(expected_combined_ids.is_subset(&combined_gradient_ids));
        assert!(combined_gradient_ids.is_disjoint(&rollout_ids));
    }

    #[test]
    fn schedules_continue_across_learn_calls() {
        let device = Device::Cpu;
        let mut env: VectorizedGymWrapper<FixedEnv> =
            vec![FixedEnv::new(device.clone()), FixedEnv::new(device.clone())].into();
        let actor_var_map = VarMap::new();
        let critic_var_map = VarMap::new();
        let actor_network = MLP::builder()
            .input_size(4)
            .output_size(2)
            .vb(VarBuilder::from_varmap(&actor_var_map, DType::F32, &device))
            .activation(Tensor::tanh)
            .hidden_layer_sizes(vec![2])
            .build()
            .unwrap();
        let critic_network = MLP::builder()
            .input_size(4)
            .output_size(1)
            .vb(VarBuilder::from_varmap(
                &critic_var_map,
                DType::F32,
                &device,
            ))
            .activation(Tensor::tanh)
            .hidden_layer_sizes(vec![2])
            .build()
            .unwrap();
        let network_info = PPONetworkInfo::Separate(
            SeparatePPONetwork::builder()
                .actor_optimizer(CountingOptimizer::with_learning_rate(1e-3))
                .critic_optimizer(CountingOptimizer::with_learning_rate(1e-3))
                .actor_network(ProbabilisticPolicyModel::<CategoricalDistribution>::new(
                    actor_network,
                ))
                .critic_network(critic_network)
                .actor_lr_scheduler(LinearSchedule::new(1e-3, 1e-4))
                .critic_lr_scheduler(LinearSchedule::new(1e-3, 1e-4))
                .build(),
        );
        let mut agent = PPOAgent::builder()
            .action_space(env.action_space())
            .network_info(network_info)
            .batch_size(2)
            .mini_batch_size(2)
            .num_epochs(1)
            .clip_range(LinearSchedule::new(0.2, 0.1))
            .training_horizon(10)
            .device(device.clone())
            .build()
            .unwrap();

        agent.learn(&mut env, 2).unwrap();
        assert_eq!(agent.schedule_progress.elapsed_steps(), 2);
        assert_close(agent.schedule_progress.parameter(&*agent.clip_range), 0.18);
        let PPONetworkInfo::Separate(network) = &agent.network_info else {
            panic!("expected separate PPO network");
        };
        assert_close(network.actor_optimizer.learning_rate(), 0.00082);
        assert_close(network.critic_optimizer.learning_rate(), 0.00082);
        assert_eq!(network.actor_optimizer.steps, 1);
        assert_eq!(network.critic_optimizer.steps, 1);
        agent.learn(&mut env, 2).unwrap();

        assert_eq!(agent.schedule_progress.elapsed_steps(), 4);
        assert_close(agent.schedule_progress.parameter(&*agent.clip_range), 0.16);
        let PPONetworkInfo::Separate(network) = &agent.network_info else {
            panic!("expected separate PPO network");
        };
        assert_close(network.actor_optimizer.learning_rate(), 0.00064);
        assert_close(network.critic_optimizer.learning_rate(), 0.00064);
        assert_eq!(network.actor_optimizer.steps, 2);
        assert_eq!(network.critic_optimizer.steps, 2);

        let observations = Tensor::zeros((2, 4), DType::F32, &device).unwrap();
        assert_eq!(agent.act(&observations).unwrap().dims(), &[2]);
        assert_eq!(agent.act_deterministic(&observations).unwrap().dims(), &[2]);
        agent.set_learning_rate(0.25);
        let PPONetworkInfo::Separate(network) = &agent.network_info else {
            panic!("expected separate PPO network");
        };
        assert_close(network.actor_optimizer.learning_rate(), 0.25);
        assert_close(network.critic_optimizer.learning_rate(), 0.25);
    }
}