-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathnnet-descriptor.cc
1129 lines (1020 loc) · 38 KB
/
nnet-descriptor.cc
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
// nnet3/nnet-descriptor.cc
// Copyright 2015 Johns Hopkins University (author: Daniel Povey)
// See ../../COPYING for clarification regarding multiple authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
// WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
// MERCHANTABLITY OR NON-INFRINGEMENT.
// See the Apache 2 License for the specific language governing permissions and
// limitations under the License.
#include <iterator>
#include <sstream>
#include "nnet3/nnet-descriptor.h"
#include "nnet3/nnet-nnet.h"
#include "nnet3/nnet-computation-graph.h"
namespace kaldi {
namespace nnet3 {
static std::string ParsingContext(const std::string *token_ptr) {
if (*token_ptr == "end of input")
return "";
std::string next_few_tokens = ", next part of line is: ";
// in the next line, *token_ptr should never equal "" but it's to mitigate the
// effect of bugs where we read past the end of the array.
while (*token_ptr != "end of input" && *token_ptr != "" &&
next_few_tokens.size() < 40) {
next_few_tokens = (next_few_tokens + " ") + *token_ptr;
token_ptr++;
}
if (*token_ptr != "end of input")
next_few_tokens = next_few_tokens + " ...";
return next_few_tokens;
}
static void ExpectToken(const std::string &token,
const std::string &what_we_are_parsing,
const std::string **next_token) {
if (**next_token != token)
KALDI_ERR << "Expected '" << token << "' while parsing "
<< what_we_are_parsing << ", got "
<< **next_token << ParsingContext(*next_token);
else // advance token pointer.
(*next_token)++;
}
static int32 ReadIntegerToken(const std::string &what_we_are_parsing,
const std::string **next_token) {
int32 ans;
if (!ConvertStringToInteger(**next_token, &ans))
KALDI_ERR << "Expected integer while parsing "
<< what_we_are_parsing << ", got '"
<< **next_token << "'" << ParsingContext(*next_token);
(*next_token)++; // advance token pointer.
return ans;
}
void Descriptor::GetDependencies(
const Index &index,
std::vector<Cindex> *dependencies) const {
dependencies->clear();
std::vector<SumDescriptor*>::const_iterator sum_iter = parts_.begin(),
sum_end = parts_.end();
std::vector<Cindex> this_part;
for (; sum_iter != sum_end; ++sum_iter)
(*sum_iter)->GetDependencies(index, dependencies);
}
int32 SimpleForwardingDescriptor::Dim(const Nnet &nnet) const {
return nnet.GetNode(src_node_).Dim(nnet);
}
BaseFloat SimpleForwardingDescriptor::GetScaleForNode(int32 node_index) const {
if (node_index == src_node_) return scale_;
else return std::numeric_limits<BaseFloat>::infinity();
}
Cindex SimpleForwardingDescriptor::MapToInput(const Index &index) const {
return Cindex(src_node_, index);
}
ForwardingDescriptor *SimpleForwardingDescriptor::Copy() const {
return new SimpleForwardingDescriptor(src_node_, scale_);
}
void SimpleForwardingDescriptor::GetNodeDependencies(
std::vector<int32> *node_indexes) const {
node_indexes->push_back(src_node_);
}
void SimpleForwardingDescriptor::WriteConfig(
std::ostream &os,
const std::vector<std::string> &node_names) const {
KALDI_ASSERT(static_cast<size_t>(src_node_) < node_names.size());
if (scale_ == 1.0) {
os << node_names[src_node_];
} else {
os << "Scale(" << scale_ << ", " << node_names[src_node_] << ")";
}
}
void OffsetForwardingDescriptor::GetNodeDependencies(
std::vector<int32> *node_indexes) const {
src_->GetNodeDependencies(node_indexes);
}
BaseFloat OffsetForwardingDescriptor::GetScaleForNode(int32 node_index) const {
return src_->GetScaleForNode(node_index);
}
Cindex OffsetForwardingDescriptor::MapToInput(const Index &ind) const {
Index ind_mod(ind);
ind_mod += offset_;
return src_->MapToInput(ind_mod);
}
ForwardingDescriptor *OffsetForwardingDescriptor::Copy() const {
return new OffsetForwardingDescriptor(src_->Copy(), offset_);
}
void OffsetForwardingDescriptor::WriteConfig(
std::ostream &os,
const std::vector<std::string> &node_names) const {
KALDI_ASSERT(offset_.n == 0);
os << "Offset(";
src_->WriteConfig(os, node_names);
os << ", " << offset_.t;
if (offset_.x != 0)
os << ", " << offset_.x;
os << ")";
}
void SwitchingForwardingDescriptor::GetNodeDependencies(
std::vector<int32> *node_indexes) const {
for (size_t i = 0; i < src_.size(); i++)
src_[i]->GetNodeDependencies(node_indexes);
}
Cindex SwitchingForwardingDescriptor::MapToInput(const Index &ind) const {
KALDI_ASSERT(!src_.empty());
int32 size = src_.size(), mod = ind.t % size;
// next line gets "mathematical" modulus, not broken "C" modulus.
if (mod < 0) mod += size;
return src_[mod]->MapToInput(ind);
}
ForwardingDescriptor *SwitchingForwardingDescriptor::Copy() const {
std::vector<ForwardingDescriptor*> src_copy(src_.size());
for (size_t i = 0; i < src_.size(); i++)
src_copy[i] = src_[i]->Copy();
return new SwitchingForwardingDescriptor(src_copy);
}
void SwitchingForwardingDescriptor::WriteConfig(
std::ostream &os,
const std::vector<std::string> &node_names) const {
KALDI_ASSERT(!src_.empty());
os << "Switch(";
for (size_t i = 0; i < src_.size(); i++) {
src_[i]->WriteConfig(os, node_names);
if (i + 1 < src_.size())
os << ", ";
}
os << ")";
}
void RoundingForwardingDescriptor::GetNodeDependencies(
std::vector<int32> *node_indexes) const {
src_->GetNodeDependencies(node_indexes);
}
BaseFloat RoundingForwardingDescriptor::GetScaleForNode(
int32 node_index) const {
return src_->GetScaleForNode(node_index);
}
Cindex RoundingForwardingDescriptor::MapToInput(const Index &ind) const {
KALDI_ASSERT(t_modulus_ >= 1);
Index ind_mod(ind);
// unfortunately doing "mathematical" modulus is a bit painful in C.
int32 mod = ind_mod.t % t_modulus_;
if (mod < 0)
mod += t_modulus_;
ind_mod.t -= mod;
return src_->MapToInput(ind_mod);
}
ForwardingDescriptor *RoundingForwardingDescriptor::Copy() const {
return new RoundingForwardingDescriptor(src_->Copy(), t_modulus_);
}
void RoundingForwardingDescriptor::WriteConfig(
std::ostream &os,
const std::vector<std::string> &node_names) const {
os << "Round(";
src_->WriteConfig(os, node_names);
os << ", " << t_modulus_ << ")";
}
void ReplaceIndexForwardingDescriptor::GetNodeDependencies(
std::vector<int32> *node_indexes) const {
src_->GetNodeDependencies(node_indexes);
}
BaseFloat ReplaceIndexForwardingDescriptor::GetScaleForNode(
int32 node_index) const {
return src_->GetScaleForNode(node_index);
}
Cindex ReplaceIndexForwardingDescriptor::MapToInput(const Index &ind) const {
Index ind_mod(ind);
switch (variable_name_) {
case kT: ind_mod.t = value_; break;
case kX: ind_mod.x = value_; break;
default: // kN or any other value is not allowed (doesn't make sense
// to change the minibatch index in this way).
KALDI_ERR << "Invalid variable name";
}
return src_->MapToInput(ind_mod);
}
ForwardingDescriptor *ReplaceIndexForwardingDescriptor::Copy() const {
return new ReplaceIndexForwardingDescriptor(src_->Copy(),
variable_name_, value_);
}
void ReplaceIndexForwardingDescriptor::WriteConfig(
std::ostream &os,
const std::vector<std::string> &node_names) const {
os << "ReplaceIndex(";
src_->WriteConfig(os, node_names);
KALDI_ASSERT(variable_name_ == kT || variable_name_ == kX);
os << ", " << (variable_name_ == kT ? "t" : "x") << ", "
<< value_ << ")";
}
SumDescriptor *OptionalSumDescriptor::Copy() const {
return new OptionalSumDescriptor(src_->Copy());
}
void OptionalSumDescriptor::GetDependencies(
const Index &ind,
std::vector<Cindex> *dependencies) const {
src_->GetDependencies(ind, dependencies);
}
void OptionalSumDescriptor::WriteConfig(
std::ostream &os,
const std::vector<std::string> &node_names) const {
os << "IfDefined(";
src_->WriteConfig(os, node_names);
os << ")";
}
int32 OptionalSumDescriptor::Dim(const Nnet &nnet) const {
return src_->Dim(nnet);
}
BaseFloat OptionalSumDescriptor::GetScaleForNode(int32 node_index) const {
BaseFloat ans = src_->GetScaleForNode(node_index);
if (node_index < 0 && ans != 0.0) {
// node_index < 0 means that the user is querying about the scale this
// expression puts on the constant value. If there is a nonzero scale
// (i.e. a Const() expression) inside an IfDefined() expression, which
// is what OptionalSumDescriptor handles, then it is an error: the user
// is trying to code something that we do not currently support.
KALDI_ERR << "Illegal combination of IfDefined() expression and "
"Const() expression encountered.";
}
return ans;
}
void OptionalSumDescriptor::GetNodeDependencies(
std::vector<int32> *node_indexes) const {
src_->GetNodeDependencies(node_indexes);
}
SumDescriptor *SimpleSumDescriptor::Copy() const {
return new SimpleSumDescriptor(src_->Copy());
}
void SimpleSumDescriptor::GetDependencies(const Index &ind,
std::vector<Cindex> *dependencies) const {
dependencies->push_back(src_->MapToInput(ind));
}
bool SimpleSumDescriptor::IsComputable(
const Index &ind,
const CindexSet &cindex_set,
std::vector<Cindex> *used_inputs) const {
Cindex c = src_->MapToInput(ind);
bool src_present = cindex_set(c);
if (src_present && used_inputs != NULL)
used_inputs->push_back(c);
return src_present;
}
void SimpleSumDescriptor::WriteConfig(
std::ostream &os,
const std::vector<std::string> &node_names) const {
src_->WriteConfig(os, node_names);
}
int32 SimpleSumDescriptor::Dim(const Nnet &nnet) const {
return src_->Dim(nnet);
}
BaseFloat SimpleSumDescriptor::GetScaleForNode(int32 node_index) const {
if (node_index >= 0) return src_->GetScaleForNode(node_index);
else return 0.0; // scale of constant term, which does not appear in
// ForwardingDescriptors, hence 0.0.
}
void SimpleSumDescriptor::GetNodeDependencies(
std::vector<int32> *node_indexes) const {
src_->GetNodeDependencies(node_indexes);
}
BaseFloat ConstantSumDescriptor::GetScaleForNode(int32 node_index) const {
if (node_index < 0) return value_;
else return std::numeric_limits<BaseFloat>::infinity();
}
void ConstantSumDescriptor::WriteConfig(
std::ostream &os, const std::vector<std::string> &node_names) const {
os << "Const(" << value_ << ", " << dim_ << ')';
}
SumDescriptor* ConstantSumDescriptor::Copy() const {
return new ConstantSumDescriptor(value_, dim_);
}
ConstantSumDescriptor::ConstantSumDescriptor(BaseFloat value,
int32 dim):
value_(value), dim_(dim) {
KALDI_ASSERT(dim > 0 && (value - value == 0.0));
}
void BinarySumDescriptor::GetDependencies(
const Index &ind, std::vector<Cindex> *dependencies) const {
src1_->GetDependencies(ind, dependencies);
src2_->GetDependencies(ind, dependencies);
}
bool BinarySumDescriptor::IsComputable(
const Index &ind,
const CindexSet &cindex_set,
std::vector<Cindex> *used_inputs) const {
std::vector<Cindex> src1_inputs, src2_inputs;
bool r = (used_inputs != NULL);
bool src1_computable = src1_->IsComputable(ind, cindex_set,
r ? &src1_inputs: NULL),
src2_computable = src2_->IsComputable(ind, cindex_set,
r ? &src2_inputs : NULL);
if (op_ == kSumOperation) {
if (src1_computable && src2_computable) {
if (r) {
used_inputs->insert(used_inputs->end(),
src1_inputs.begin(), src1_inputs.end());
used_inputs->insert(used_inputs->end(),
src2_inputs.begin(), src2_inputs.end());
}
return true;
} else {
return false;
}
} else {
KALDI_ASSERT(op_ == kFailoverOperation);
if (src1_computable) {
if (r)
used_inputs->insert(used_inputs->end(),
src1_inputs.begin(), src1_inputs.end());
return true;
} else if (src2_computable) {
if (r)
used_inputs->insert(used_inputs->end(),
src2_inputs.begin(), src2_inputs.end());
return true;
} else {
return false;
}
}
}
int32 BinarySumDescriptor::Dim(const Nnet &nnet) const {
int32 dim1 = src1_->Dim(nnet), dim2 = src2_->Dim(nnet);
if (dim1 != dim2)
KALDI_ERR << "Neural net contains " << (op_ == kSumOperation ? "Sum" :
"Failover")
<< " expression with inconsistent dimension: " << dim1
<< " vs. " << dim2;
return dim1;
}
BaseFloat BinarySumDescriptor::GetScaleForNode(int32 node_index) const {
BaseFloat ans1 = src1_->GetScaleForNode(node_index),
ans2 = src2_->GetScaleForNode(node_index);
bool ans1_valid = (ans1 - ans1 == 0),
ans2_valid = (ans2 - ans2 == 0); // Test for infinity.
if (node_index < 0) { // the query is about the constant offset, not for a
// specific node.
KALDI_ASSERT(ans1_valid && ans2_valid);
if (op_ == kSumOperation) {
// For a sum operation, if there were more than one Const(..) expression,
// they would logically add together (even though it would be redundant to
// write such a thing).
return ans1 + ans2;
} else if (ans1 != ans2) {
KALDI_ERR << "Illegal combination of Failover operation with Const() "
"expression encountered in Descriptor (this is not supported).";
}
}
if (ans1_valid && ans2_valid && ans1 != ans2) {
// this would be a code error so don't print a very informative message.
KALDI_ERR << "Inconsistent value for sum descriptor: for node "
<< node_index << ", it can have scales "
<< ans1 << " vs. " << ans2 << " (you have used unsupported "
"combinations of descriptors).";
}
if (!ans2_valid) return ans1;
else return ans2;
}
void BinarySumDescriptor::GetNodeDependencies(
std::vector<int32> *node_indexes) const {
src1_->GetNodeDependencies(node_indexes);
src2_->GetNodeDependencies(node_indexes);
}
int32 BinarySumDescriptor::Modulus() const {
return Lcm(src1_->Modulus(), src2_->Modulus());
}
SumDescriptor *BinarySumDescriptor::Copy() const {
return new BinarySumDescriptor(op_, src1_->Copy(), src2_->Copy());
}
void BinarySumDescriptor::WriteConfig(
std::ostream &os,
const std::vector<std::string> &node_names) const {
KALDI_ASSERT(op_ == kSumOperation || op_ == kFailoverOperation);
if (op_ == kSumOperation) os << "Sum(";
if (op_ == kFailoverOperation) os << "Failover(";
src1_->WriteConfig(os, node_names);
os << ", ";
src2_->WriteConfig(os, node_names);
os << ")";
}
int32 SwitchingForwardingDescriptor::Modulus() const {
int32 ans = src_.size();;
for (size_t i = 0; i < src_.size(); i++)
ans = Lcm(ans, src_[i]->Modulus());
return ans;
}
BaseFloat SwitchingForwardingDescriptor::GetScaleForNode(
int32 node_index) const {
BaseFloat inf = std::numeric_limits<BaseFloat>::infinity(),
ans = inf;
for (size_t i = 0; i < src_.size(); i++) {
BaseFloat this_ans = src_[i]->GetScaleForNode(node_index);
if (this_ans != inf) {
if (ans != inf && ans != this_ans)
KALDI_ERR << "Invalid Descriptor encountered: for node-index "
<< node_index << ", got two different scales "
<< this_ans << " vs. " << ans;
ans = this_ans;
}
}
return ans;
}
bool Descriptor::Parse(const std::vector<std::string> &node_names,
const std::string **next_token) {
GeneralDescriptor *gen_desc;
try {
gen_desc = GeneralDescriptor::Parse(node_names,
next_token);
} catch (...) {
return false;
}
if (**next_token != "end of input")
KALDI_ERR << "Parsing Descriptor, expected end of input but got "
<< "'" << **next_token << "'";
Descriptor *desc = gen_desc->ConvertToDescriptor();
*this = *desc;
delete desc;
delete gen_desc;
return true;
}
void Descriptor::WriteConfig(std::ostream &os,
const std::vector<std::string> &node_names) const {
KALDI_ASSERT(parts_.size() > 0);
if (parts_.size() == 1)
parts_[0]->WriteConfig(os, node_names);
else {
os << "Append(";
for (size_t i = 0; i < parts_.size(); i++) {
parts_[i]->WriteConfig(os, node_names);
if (i + 1 < parts_.size())
os << ", ";
}
os << ")";
}
}
void Descriptor::Destroy() {
for (size_t i = 0; i < parts_.size(); i++)
delete parts_[i];
parts_.clear();
}
int32 Descriptor::Dim(const Nnet &nnet) const {
int32 num_parts = parts_.size();
int32 dim = 0;
for (int32 part = 0; part < num_parts; part++)
dim += parts_[part]->Dim(nnet);
KALDI_LOG << "dim from nnet-desc = " << dim;
KALDI_ASSERT(dim > 0);
return dim;
}
Descriptor& Descriptor::operator=(const Descriptor &other) {
Destroy();
for (size_t i = 0; i < other.parts_.size(); i++)
parts_.push_back(other.parts_[i]->Copy());
return *this;
}
int32 Descriptor::Modulus() const {
int32 ans = 1;
for (size_t i = 0; i < parts_.size(); i++)
ans = Lcm(ans, parts_[i]->Modulus());
return ans;
}
bool Descriptor::IsComputable(const Index &ind,
const CindexSet &cindex_set,
std::vector<Cindex> *input_terms) const {
if (input_terms)
input_terms->clear();
for (size_t i = 0; i < parts_.size(); i++) {
// if any of the parts is not computable, the whole is not computable.
if (!parts_[i]->IsComputable(ind, cindex_set, input_terms)) {
if (input_terms)
input_terms->clear();
return false;
}
}
return true;
}
const SumDescriptor& Descriptor::Part(int32 n) const {
KALDI_ASSERT(static_cast<size_t>(n) < parts_.size());
return *(parts_[n]);
}
void Descriptor::GetNodeDependencies(std::vector<int32> *node_indexes) const {
node_indexes->clear();
for (size_t i = 0; i < parts_.size(); i++)
parts_[i]->GetNodeDependencies(node_indexes);
}
// static
GeneralDescriptor* GeneralDescriptor::Parse(
const std::vector<std::string> &node_names,
const std::string **next_token) {
DescriptorType t;
if (**next_token == "Append") {
t = kAppend;
} else if (**next_token == "Sum") {
t = kSum;
} else if (**next_token == "Failover") {
t = kFailover;
} else if (**next_token == "IfDefined") {
t = kIfDefined;
} else if (**next_token == "Offset") {
t = kOffset;
} else if (**next_token == "Switch") {
t = kSwitch;
} else if (**next_token == "Scale") {
t = kScale;
} else if (**next_token == "Const") {
t = kConst;
} else if (**next_token == "Round") {
t = kRound;
} else if (**next_token == "ReplaceIndex") {
t = kReplaceIndex;
} else {
// what we read wasn't a reserved name like Offset, etc.
// We expect a node name in that case.
for (size_t i = 0; i < node_names.size(); i++) {
if (**next_token == node_names[i]) {
GeneralDescriptor *ans = new GeneralDescriptor(kNodeName, i);
(*next_token)++;
return ans;
}
}
KALDI_ERR << "Expected a Descriptor, got instead "
<< **next_token;
t = kNodeName; // suppress compiler warning.
}
(*next_token)++;
ExpectToken("(", "Descriptor", next_token);
GeneralDescriptor *ans = new GeneralDescriptor(t);
switch (t) {
case kAppend: case kSum: case kSwitch:
ans->ParseAppendOrSumOrSwitch(node_names, next_token); break;
case kFailover: ans->ParseFailover(node_names, next_token); break;
case kIfDefined: ans->ParseIfDefined(node_names, next_token); break;
case kOffset: ans->ParseOffset(node_names, next_token); break;
case kRound: ans->ParseRound(node_names, next_token); break;
case kReplaceIndex: ans->ParseReplaceIndex(node_names, next_token); break;
case kScale: ans->ParseScale(node_names, next_token); break;
case kConst: ans->ParseConst(node_names, next_token); break;
default:
KALDI_ERR << "Code error";
}
return ans;
}
void GeneralDescriptor::ParseAppendOrSumOrSwitch(
const std::vector<std::string> &node_names,
const std::string **next_token) {
descriptors_.push_back(Parse(node_names, next_token));
while (true) {
if (**next_token == ")") {
(*next_token)++;
return;
} else if (**next_token == ",") {
(*next_token)++;
descriptors_.push_back(Parse(node_names, next_token));
} else {
KALDI_ERR << "Expected ',' or ')', got "
<< **next_token;
}
}
}
void GeneralDescriptor::ParseIfDefined(
const std::vector<std::string> &node_names,
const std::string **next_token) {
descriptors_.push_back(Parse(node_names, next_token));
ExpectToken(")", "IfDefined", next_token);
}
void GeneralDescriptor::ParseFailover(
const std::vector<std::string> &node_names,
const std::string **next_token) {
descriptors_.push_back(Parse(node_names, next_token));
ExpectToken(",", "Failover", next_token);
descriptors_.push_back(Parse(node_names, next_token));
ExpectToken(")", "Failover", next_token);
}
void GeneralDescriptor::ParseScale(
const std::vector<std::string> &node_names,
const std::string **next_token) {
if (!ConvertStringToReal(**next_token, &alpha_)) {
KALDI_ERR << "Parsing Scale() in descriptor: expected floating-point scale"
", got: " << **next_token;
}
(*next_token)++; // Consume the float.
ExpectToken(",", "Scale", next_token);
descriptors_.push_back(Parse(node_names, next_token));
ExpectToken(")", "Scale", next_token);
}
void GeneralDescriptor::ParseConst(
const std::vector<std::string> &node_names,
const std::string **next_token) {
if (!ConvertStringToReal(**next_token, &alpha_)) {
KALDI_ERR << "Parsing Const() in descriptor: expected floating-point value"
", got: " << **next_token;
}
(*next_token)++; // Consume the float.
ExpectToken(",", "Const", next_token);
if (!ConvertStringToInteger(**next_token, &value1_) ||
value1_ <= 0) {
KALDI_ERR << "Parsing Const() in descriptor: expected nonnegative integer, "
"got: " << **next_token;
}
(*next_token)++; // Consume the int.
ExpectToken(")", "Const", next_token);
}
void GeneralDescriptor::ParseOffset(
const std::vector<std::string> &node_names,
const std::string **next_token) {
descriptors_.push_back(Parse(node_names, next_token));
ExpectToken(",", "Offset", next_token);
value1_ = ReadIntegerToken("Offset", next_token);
if (**next_token == ",") {
(*next_token)++;
value2_ = ReadIntegerToken("Offset", next_token);
} else {
value2_ = 0;
}
ExpectToken(")", "Offset", next_token);
}
void GeneralDescriptor::ParseRound(
const std::vector<std::string> &node_names,
const std::string **next_token) {
descriptors_.push_back(Parse(node_names, next_token));
ExpectToken(",", "Round", next_token);
value1_ = ReadIntegerToken("Round", next_token);
ExpectToken(")", "Round", next_token);
}
void GeneralDescriptor::ParseReplaceIndex(
const std::vector<std::string> &node_names,
const std::string **next_token) {
descriptors_.push_back(Parse(node_names, next_token));
ExpectToken(",", "ReplaceIndex", next_token);
if (**next_token == "t") {
value1_ = int32(ReplaceIndexForwardingDescriptor::kT);
(*next_token)++;
} else if (**next_token == "x") {
value1_ = int32(ReplaceIndexForwardingDescriptor::kX);
(*next_token)++;
} else {
KALDI_ERR << "Expected 't' or 'x', got " << **next_token;
}
ExpectToken(",", "ReplaceIndex", next_token);
value2_ = ReadIntegerToken("Replace", next_token);
ExpectToken(")", "ReplaceIndex", next_token);
}
int32 GeneralDescriptor::NumAppendTerms() const {
int32 ans = 0;
switch (descriptor_type_) {
case kNodeName: ans = 1; break;
case kConst: ans = 1; break;
case kAppend: {
for (size_t i = 0; i < descriptors_.size(); i++)
ans += descriptors_[i]->NumAppendTerms();
break;
}
default:
KALDI_ASSERT(descriptors_.size() > 0);
ans = descriptors_[0]->NumAppendTerms();
for (size_t i = 1; i < descriptors_.size(); i++)
KALDI_ASSERT(descriptors_[i]->NumAppendTerms() == ans);
}
return ans;
}
GeneralDescriptor* GeneralDescriptor::GetAppendTerm(int32 term) const {
switch (descriptor_type_) {
case kNodeName:
KALDI_ASSERT(term == 0);
return new GeneralDescriptor(kNodeName, value1_);
case kAppend: {
int32 cur_term = term;
for (size_t i = 0; i < descriptors_.size(); i++) {
int32 this_num_terms = descriptors_[i]->NumAppendTerms();
if (cur_term < this_num_terms)
return descriptors_[i]->GetAppendTerm(cur_term);
else
cur_term -= this_num_terms;
}
KALDI_ERR << "Code error, getting append term.";
return NULL; // avoid compiler warning
}
default: {
GeneralDescriptor *ans = new GeneralDescriptor(descriptor_type_,
value1_, value2_,
alpha_);
ans->descriptors_.resize(descriptors_.size());
for (size_t i = 0; i < descriptors_.size(); i++)
ans->descriptors_[i] = descriptors_[i]->GetAppendTerm(term);
return ans;
}
}
}
// this is only called at the top level.
GeneralDescriptor* GeneralDescriptor::NormalizeAppend() const {
int32 num_terms = NumAppendTerms();
KALDI_ASSERT(num_terms > 0);
if (num_terms == 1) {
return GetAppendTerm(0);
} else {
GeneralDescriptor *ans = new GeneralDescriptor(kAppend);
ans->descriptors_.resize(num_terms);
for (size_t i = 0; i < num_terms; i++) {
ans->descriptors_[i] = GetAppendTerm(i);
}
return ans;
}
}
// static
bool GeneralDescriptor::Normalize(GeneralDescriptor *desc) {
bool changed = false;
switch (desc->descriptor_type_) {
case kOffset: { // this block combines Offset(Offset(x, ..), ..).
KALDI_ASSERT(desc->descriptors_.size() == 1);
GeneralDescriptor *child = desc->descriptors_[0];
if (child->descriptor_type_ == kOffset) {
KALDI_ASSERT(child->descriptors_.size() == 1);
GeneralDescriptor *grandchild = child->descriptors_[0];
desc->value1_ += child->value1_;
desc->value2_ += child->value2_;
child->descriptors_.clear(); // avoid delete in destructor.
delete child;
desc->descriptors_[0] = grandchild;
changed = true;
} else if (desc->value1_ == 0 && desc->value2_ == 0) {
// remove redundant Offset expression like Offset(x, 0).
desc->descriptors_.swap(child->descriptors_);
desc->descriptor_type_ = child->descriptor_type_;
desc->value1_ = child->value1_;
desc->value2_ = child->value2_;
desc->alpha_ = child->alpha_;
child->descriptors_.clear(); // avoid delete in destructor.
delete child;
changed = true;
break; // break from the switch ('desc' is no longer of type
// kOffset)', so we don't want to carry through.
}
}
// ... and continue through to the next case statement.
case kSwitch: case kRound: case kReplaceIndex: { // ..and kOffset:
KALDI_ASSERT(desc->descriptors_.size() >= 1);
GeneralDescriptor *child = desc->descriptors_[0];
// If child->descriptor_type_ == kAppend, it would be code error since we
// already did NormalizeAppend().
KALDI_ASSERT(child->descriptor_type_ != kAppend);
if (child->descriptor_type_ == kSum ||
child->descriptor_type_ == kFailover ||
child->descriptor_type_ == kIfDefined) {
if (desc->descriptors_.size() > 1) {
KALDI_ASSERT(desc->descriptor_type_ == kSwitch);
KALDI_ERR << "Sum(), Failover() or IfDefined() expression inside Switch(), "
<< "we can't currently normalize this.";
}
// this is a forbidden case of a sum descriptor inside a forwarding
// descriptor. we need to rearrange. E.g. Offset(Sum(x, y), 1) becomes
// Sum(Offset(x, 1), Offset(y, 1)).
for (size_t i = 0; i < child->descriptors_.size(); i++) {
GeneralDescriptor *grandchild = child->descriptors_[i];
GeneralDescriptor *modified_grandchild =
new GeneralDescriptor(desc->descriptor_type_,
desc->value1_,
desc->value2_,
desc->alpha_);
// modified_grandchild takes ownership of grandchild.
modified_grandchild->descriptors_.push_back(grandchild);
child->descriptors_[i] = modified_grandchild;
}
// copy all members from child to desc.
desc->descriptor_type_ = child->descriptor_type_;
desc->value1_ = child->value1_;
desc->value2_ = child->value2_;
desc->descriptors_.swap(child->descriptors_);
child->descriptors_.clear(); // avoid delete in destructor of 'child'
delete child;
changed = true;
}
break;
}
case kSum: {
KALDI_ASSERT(!desc->descriptors_.empty());
if (desc->descriptors_.size() == 1) {
// convert Sum(x) to just x.
GeneralDescriptor *child = desc->descriptors_[0];
desc->descriptor_type_ = child->descriptor_type_;
desc->descriptors_.swap(child->descriptors_);
desc->value1_ = child->value1_;
desc->value2_ = child->value2_;
desc->alpha_ = child->alpha_;
child->descriptors_.clear(); // avoid delete in destructor.
delete child;
changed = true;
} else if (desc->descriptors_.size() > 2) {
// convert Sum(a, b, c, ...) to Sum(a, Sum(b, c, ...)).
GeneralDescriptor *new_child = new GeneralDescriptor(kSum);
// assign b, c, .. to the descriptors of new_child.
new_child->descriptors_.insert(new_child->descriptors_.begin(),
desc->descriptors_.begin() + 1,
desc->descriptors_.end());
desc->descriptors_.erase(desc->descriptors_.begin() + 1,
desc->descriptors_.end());
desc->descriptors_.push_back(new_child);
changed = true;
}
break;
}
case kScale: {
KALDI_ASSERT(desc->descriptors_.size() == 1);
GeneralDescriptor *child = desc->descriptors_[0];
if (child->descriptor_type_ == kOffset ||
child->descriptor_type_ == kReplaceIndex ||
child->descriptor_type_ == kRound) {
// push the Scale() inside those expressions.
std::swap(desc->descriptor_type_, child->descriptor_type_);
std::swap(desc->alpha_, child->alpha_);
std::swap(desc->value1_, child->value1_);
std::swap(desc->value2_, child->value2_);
changed = true;
} else if (child->descriptor_type_ == kSum) {
// Push the Scale() inside the sum expression.
desc->descriptors_.clear();
for (size_t i = 0; i < child->descriptors_.size(); i++) {
GeneralDescriptor *new_child =
new GeneralDescriptor(kScale, -1, -1, desc->alpha_);
new_child->descriptors_.push_back(child->descriptors_[i]);
desc->descriptors_.push_back(new_child);
}
desc->descriptor_type_ = kSum;
desc->alpha_ = 0.0;
child->descriptors_.clear(); // prevent them being freed.
delete child;
changed = true;
} else if (child->descriptor_type_ == kScale) {
// Combine the 'scale' expressions.
KALDI_ASSERT(child->descriptors_.size() == 1);
GeneralDescriptor *grandchild = child->descriptors_[0];
desc->alpha_ *= child->alpha_;
desc->descriptors_[0] = grandchild;
child->descriptors_.clear(); // prevent them being freed.
delete child;
changed = true;
} else if (child->descriptor_type_ != kNodeName) {
KALDI_ERR << "Unhandled case encountered when normalizing Descriptor; "
"you can work around this by pushing Scale() inside "
"other expressions.";
}
break;
}
default: { } // empty statement
}
// ... and recurse.
for (size_t i = 0; i < desc->descriptors_.size(); i++)
changed = changed || Normalize(desc->descriptors_[i]);
return changed;
}
GeneralDescriptor* GeneralDescriptor::GetNormalizedDescriptor() const {
GeneralDescriptor *ans = NormalizeAppend();
while (Normalize(ans)); // keep normalizing as long as it changes.
return ans;
}
void GeneralDescriptor::Print(const std::vector<std::string> &node_names,
std::ostream &os) {
switch (descriptor_type_) {
// first handle all the expressions of the form "Operator(<desc1>, ... <descN>)".
case kAppend: os << "Append("; break;
case kSum: os << "Sum("; break;
case kFailover: os << "Failover("; break;
case kIfDefined: os << "IfDefined("; break;
case kSwitch: os << "Switch("; break;
// Scale() ends in a descriptor, so we also break and let the generic code
// handle that.
case kScale: os << "Scale(" << alpha_ << ", "; break;
// now handle the exceptions.
case kOffset: case kRound: {
os << "Offset(";
KALDI_ASSERT(descriptors_.size() == 1);
descriptors_[0]->Print(node_names, os);
os << ", " << value1_;
if (descriptor_type_ == kOffset && value2_ != 0) os << ", " << value2_;
os << ")";
return;
}
case kReplaceIndex: {
os << "ReplaceIndex(";
KALDI_ASSERT(descriptors_.size() == 1);