├── CodeEnv.py ├── Hmat ├── BCH_63_45_oc.mat ├── BCH_63_45_std.mat ├── RM_2_5_oc.mat ├── RM_2_5_std.mat ├── RM_3_6_oc.mat ├── RM_3_6_std.mat ├── RM_3_7_oc.mat ├── RM_3_7_std.mat ├── RM_4_7_oc.mat └── RM_4_7_std.mat ├── LICENSE ├── README.md ├── eval.py ├── jobscript ├── kill_last_pid ├── last_pid ├── opt.py ├── optscript ├── rllib.yml └── utils.py /CodeEnv.py: -------------------------------------------------------------------------------- 1 | import gym 2 | import numpy as np 3 | import scipy.io as sio 4 | import os 5 | from pathlib import Path 6 | from utils import * 7 | 8 | # default for maxIter : env.spec.max_episode_steps 9 | 10 | class CodeEnv(gym.Env): 11 | def __init__(self, env_config): # RLLIB: custom env classes must take a single config parameter 12 | """ 13 | Args: 14 | code: string that identifies the parity-check matrix, e.g., "RM_2_5_std" 15 | maxIter: maximum number of decoding iterations 16 | EbNo_dB: training signal-to-noise ratio (SNR) in dB 17 | 18 | (optional): 19 | WBF: weighted bit-flipping (default: False) 20 | Lmax: maximum LLR value (default: 2.0) 21 | asort: automorphism sort (default: False), strategy depends on the code (either RM or BCH) 22 | asortk: if asort==True for BCH codes (default: -2) 23 | path_to_Hmat: path to .mat file for H (default: "~/Hmat") 24 | Hrank: rank of the parity-check matrix (default: will be computed which may take some time) 25 | """ 26 | 27 | self.code = env_config["code"] 28 | #path_to_Hmat = env_config.get("path_to_Hmat", "default") 29 | if "path_to_Hmat" in env_config: 30 | path_to_Hmat = Path(env_config["path_to_Hmat"]) 31 | else: 32 | path_to_Hmat = Path.home() / "Hmat" 33 | print("CodeEnv: path_to_Hmat not specified. Looking in "+str(path_to_Hmat)) 34 | 35 | # optional parameters 36 | self.WBF = env_config.get("WBF", False) 37 | self.Lmax = env_config.get("Lmax", 2.0) 38 | self.asort = env_config.get("asort", False) 39 | 40 | # environment setup 41 | H = sio.loadmat(str(path_to_Hmat / env_config["code"]))['H'] 42 | H = np.int64(H) 43 | self.H = H 44 | self.m = self.H.shape[0] # number of parity checks 45 | self.n = self.H.shape[1] # code length 46 | print("determining rank(H) ...") 47 | self.Hrank = env_config.get("Hrank", gfrank(self.H)) # n-k 48 | print("rank(H) = {}".format(self.Hrank)) 49 | self.k = self.n - self.Hrank # code dimension 50 | self.R = self.k/self.n # code rate 51 | self.action_space = gym.spaces.Discrete(self.n) 52 | self.absL_avg = np.zeros(shape=self.n) # running average of abs(LLRs) 53 | self.path_penality = np.zeros(shape=self.n) 54 | self.totCw = 0 # number of total codewords = number of resets 55 | 56 | self.maxIter = env_config["maxIter"] 57 | self.set_EbNo_dB(env_config["EbNo_dB"]) 58 | 59 | if self.WBF == True: 60 | # (s,r) 61 | #P1 = gym.spaces.Tuple((gym.spaces.Discrete(2),)*self.m) # binary tuple/vector 62 | #P2 = gym.spaces.Box(low=0, high=self.Lmax, shape=[self.m], dtype=np.float32) # binary tuple/vector 63 | #self.observation_space = gym.spaces.tuple((P1, P2)) 64 | 65 | self.observation_space = gym.spaces.Box(low=-self.Lmax, high=self.Lmax, shape=[self.m], dtype=np.float32) # binary tuple/vector 66 | self.CN_neighbors = [self.H[i,:].nonzero() for i in range(self.m)] 67 | else: 68 | self.observation_space = gym.spaces.Tuple((gym.spaces.Discrete(2),)*self.m) # binary tuple/vector 69 | 70 | self.reset() 71 | 72 | def set_EbNo_dB(self, x): 73 | self.EbNo_dB = x 74 | self.sigma2 = 1/(2*self.R*10**(self.EbNo_dB/10)) 75 | 76 | def reset(self): # all-zero codeword transmission 77 | c = np.zeros(self.n, dtype=np.int) 78 | y = (-2*c+1) + np.random.normal(scale=np.sqrt(self.sigma2), size=self.n) 79 | 80 | if self.asort == True: 81 | if "RM" in self.code: 82 | sind = find_rm_auto(y) 83 | elif "BCH" in self.code: 84 | sind = find_cyclic_auto(y,-2) 85 | else: 86 | raise ValueError("code string must contain either RM or BCH if asort==True") 87 | y = y[sind] 88 | 89 | l = 2*y/self.sigma2 # LLRs 90 | z = np.zeros(self.n, dtype=np.int) 91 | z[y<0] = 1 # hard decision observation 92 | 93 | # if asort == False, this should converge to uniform 94 | self.absL_avg = (abs(l) + self.totCw*self.absL_avg)/(self.totCw + 1) 95 | 96 | self.chat = z # current codeword estimate (including bit flips) 97 | self.error_locations = np.where(z==1)[0] 98 | self.nerr = len(self.error_locations) 99 | 100 | # generate syndrome 101 | self.syndrome = np.zeros(self.m, dtype=np.int64) 102 | for i in self.error_locations: 103 | self.syndrome = (self.syndrome + self.H[:,i]) % 2 104 | 105 | if self.WBF == True: # compute soft syndrome 106 | self.r = np.abs(y) 107 | self.phi = [self.r[self.CN_neighbors[i]].min() for i in range(self.m)] 108 | self.soft_syndrome = (-2*self.syndrome+1) * self.phi 109 | self._state = self.soft_syndrome 110 | self.path_penality = - abs(l) / np.mean(self.absL_avg) * 1.0/self.maxIter 111 | 112 | # new 113 | #self._state = tuple(tuple(self.syndrome), self.r) 114 | else: 115 | self._state = tuple(self.syndrome) 116 | self.path_penality = - self.absL_avg / np.mean(self.absL_avg) * 1.0/self.maxIter 117 | 118 | self.nmove = 0 119 | self.totCw += 1 120 | #return self._get_obs() 121 | return self._state 122 | 123 | # def _get_obs(self): 124 | # if self.WBF == True: 125 | # return self._state # for Box, np.arrays are required as input 126 | # else: 127 | # return tuple(self._state) 128 | 129 | def step(self, action): # see http://gym.openai.com/docs/#observations 130 | self.nmove += 1 131 | self.chat[action] = (self.chat[action] + 1) % 2 132 | self.syndrome = (self.syndrome + self.H[:, action]) % 2 133 | if self.WBF == True: 134 | # update reliabilities + recompute phi 135 | #self.r[action] = self.Lmax 136 | #self.phi = [self.r[self.CN_neighbors[i]].min() for i in range(self.m)] 137 | 138 | self._state = (-2*self.syndrome+1) * self.ph 139 | 140 | # new 141 | #self._state = tuple(tuple(self.syndrome), self.r) 142 | else: 143 | self._state = tuple(self.syndrome) 144 | 145 | if (self.syndrome.sum() == 0): 146 | done = True 147 | reward = self.path_penality[action] + 1 148 | else: 149 | done = False 150 | reward = self.path_penality[action] 151 | 152 | #if self.WBF == True: # update path penalities 153 | # self.path_penality[action] = -self.Lmax # may be too high 154 | 155 | if self.nmove >= self.maxIter: 156 | done = True 157 | 158 | return self._state, reward, done, {} 159 | 160 | def render(self): 161 | print('move:',self.nmove,'chat:',self.chat,' state:', self._state) 162 | #print('nerr:',self.nerr,' err loc',self.errloc,' nmove:',self.nmove,' state:', self._state) 163 | -------------------------------------------------------------------------------- /Hmat/BCH_63_45_oc.mat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabriziocarpi/RLdecoding/f8c624ae6f02bf869ccfa2082c11be28ea4ea3af/Hmat/BCH_63_45_oc.mat -------------------------------------------------------------------------------- /Hmat/BCH_63_45_std.mat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabriziocarpi/RLdecoding/f8c624ae6f02bf869ccfa2082c11be28ea4ea3af/Hmat/BCH_63_45_std.mat -------------------------------------------------------------------------------- /Hmat/RM_2_5_oc.mat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabriziocarpi/RLdecoding/f8c624ae6f02bf869ccfa2082c11be28ea4ea3af/Hmat/RM_2_5_oc.mat -------------------------------------------------------------------------------- /Hmat/RM_2_5_std.mat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabriziocarpi/RLdecoding/f8c624ae6f02bf869ccfa2082c11be28ea4ea3af/Hmat/RM_2_5_std.mat -------------------------------------------------------------------------------- /Hmat/RM_3_6_oc.mat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabriziocarpi/RLdecoding/f8c624ae6f02bf869ccfa2082c11be28ea4ea3af/Hmat/RM_3_6_oc.mat -------------------------------------------------------------------------------- /Hmat/RM_3_6_std.mat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabriziocarpi/RLdecoding/f8c624ae6f02bf869ccfa2082c11be28ea4ea3af/Hmat/RM_3_6_std.mat -------------------------------------------------------------------------------- /Hmat/RM_3_7_oc.mat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabriziocarpi/RLdecoding/f8c624ae6f02bf869ccfa2082c11be28ea4ea3af/Hmat/RM_3_7_oc.mat -------------------------------------------------------------------------------- /Hmat/RM_3_7_std.mat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabriziocarpi/RLdecoding/f8c624ae6f02bf869ccfa2082c11be28ea4ea3af/Hmat/RM_3_7_std.mat -------------------------------------------------------------------------------- /Hmat/RM_4_7_oc.mat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabriziocarpi/RLdecoding/f8c624ae6f02bf869ccfa2082c11be28ea4ea3af/Hmat/RM_4_7_oc.mat -------------------------------------------------------------------------------- /Hmat/RM_4_7_std.mat: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fabriziocarpi/RLdecoding/f8c624ae6f02bf869ccfa2082c11be28ea4ea3af/Hmat/RM_4_7_std.mat -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # CodeEnv: Learning Bit-Flipping Decoding 2 | 3 | This repository includes a collection of Python and Tensorflow scripts to learn Bit Flipping decoding through Reinforcement Learning. 4 | 5 | Additional details are explained in this paper: 6 | 7 | * F. Carpi, C. Häger, M. Martalò, R. Raheli, H. D. Pfister, "[Reinforcement 8 | Learning for Channel Coding: Learned Bit-Flipping 9 | Decoding](https://doi.org/10.1109/ALLERTON.2019.8919799)", in Proc. 2019 57th Annual Allerton Conference on Communication, Control and Computing (Allerton), Monticello, IL, USA, September 2019. 10 | 11 | [Arxiv:1906.04448](https://arxiv.org/abs/1906.04448) 12 | 13 | --- 14 | 15 | ## Parity Check matrices 16 | 17 | The Parity Check (PC) matrices for the following codes are contained in the `Hmat` folder: 18 | - Reed–Muller (RM) codes: 19 | - RM(2,5) 20 | - RM(3,6) 21 | - RM(3,7) 22 | - RM(4,7) 23 | 24 | - Bose–Chaudhuri–Hocquenghem (BCH) codes: 25 | - BCH(63,45) 26 | 27 | The suffix denotes: 28 | - `_std`: standard PC matrix 29 | - `_oc`: overcomplete PC matrix (the rows are dual codewords) 30 | 31 | ## Getting Started 32 | 33 | The main code is contained in the files: 34 | 35 | * `CodeEnv.py`: environment class based on [OpenAI 36 | Gym](https://gym.openai.com/) 37 | * `utils.py`: various helper functions (mainly to implement the permutation 38 | preprocessing based on the code's automorphism group) 39 | 40 | The actual optimization uses 41 | [RLlib](https://ray.readthedocs.io/en/latest/rllib.html) and 42 | [Tune](https://ray.readthedocs.io/en/latest/tune.html), both of which are based 43 | on [Ray](https://ray.readthedocs.io/en/latest/index.html). 44 | 45 | ## Workflow 46 | 47 | ### 0) Initialization 48 | Make sure Ray and RLlib are installed. An example of Anaconda environment is provided in `rllib.yml`. 49 | 50 | 51 | ### 1) Update config settings and log folder 52 | 53 | In `opt.py`, edit the following: 54 | > codedir = "" 55 | > tmpdir = "" 56 | 57 | Then, copy the folder `Hmat` to the project directory, i.e., `codedir/Hmat`. 58 | The log folder is set to `codedir/ray_results`. 59 | The Ray session will store temporary files in `tmpdir/ray`. 60 | 61 | Note that, in `opt.py`, the training hyperparameters can be changed. Moreover, accordingly to computation capabilities, the number of CPU/GPU may be edited as well: 62 | > "num_gpus" : , 63 | > "num_workers": 64 | 65 | 66 | 67 | ### 2) Run the optimization and explore hyperparameters 68 | 69 | Use `optscript` to run `opt.py` from the terminal. This file just writes the process ID to the file `last_pid` and calls `opt.py`. In case something goes wrong, use `kill_last_pid` to terminate this process and all child processes created by Ray. 70 | 71 | Note that a new directory ``, containing all the model's files, will be created under `codedir/ray_results/CodeEnv/` 72 | 73 | 74 | Tensorboard can be used with the specified log directory to monitor the training progress. 75 | 76 | 77 | ### 3) Evaluate the trained model 78 | 79 | Finally, use `jobscript` to evaluate the trained model for a specified range of SNRs. This script calls `eval.py` which then saves the results into .mat and .txt files. 80 | 81 | Modify `jobscript`, inserting the proper folder for your trained model: 82 | > resultPath = "insert-path-to-" 83 | 84 | 85 | As in point 1), change in `eval.py`: 86 | > tmpdir = "" 87 | 88 | 89 | --- 90 | ### Notes 91 | 92 | The current scripts replicate the results for RM (2,5) [LBF-NN] and [s+d LBF-NN]. 93 | 94 | Please send any feedback, comment or request to [Fabrizio Carpi](https://fabriziocarpi.github.io/) or [Christian Häger](http://www.christianhaeger.de/index.html). 95 | -------------------------------------------------------------------------------- /eval.py: -------------------------------------------------------------------------------- 1 | # ============================================================== # 2 | # imports {{{ 3 | # ============================================================== # 4 | import gym 5 | import sys 6 | from gym import spaces 7 | import numpy as np 8 | import scipy.io as sio 9 | import json # json.loads 10 | import os # os.listdir 11 | import re # re.findall 12 | import ray 13 | import ray.rllib.agents.dqn as dqn 14 | import argparse as ap 15 | 16 | from CodeEnv import * 17 | # }}} 18 | # ============================================================== # 19 | # parameters {{{ 20 | # ============================================================== # 21 | tmpdir = "/tmp/fc94" 22 | 23 | 24 | parser = ap.ArgumentParser("python eval.py") 25 | parser.add_argument("dB_range", help="set of SNRs, e.g., [5] or [2,3,4]") 26 | parser.add_argument("minCwErr", help="get at least this many codeword errors") 27 | parser.add_argument("maxCw", help="but stop if this many codewords have been simulated") 28 | parser.add_argument("NUM", help="number appended to the name of the result file") 29 | parser.add_argument("--path", dest="path_to_results", default="./latest", help="path to the result directory") 30 | parser.add_argument('--save', dest='SAVE', action='store_true') 31 | parser.add_argument('--no-save', dest='SAVE', action='store_false') 32 | parser.set_defaults(SAVE=True) 33 | 34 | args = parser.parse_args() 35 | 36 | dB_range = np.asarray(eval(args.dB_range)) 37 | minCwErr = int(args.minCwErr) 38 | maxCw = int(args.maxCw) 39 | NUM = int(args.NUM) 40 | path_to_results = args.path_to_results 41 | SAVE = args.SAVE 42 | 43 | if SAVE: 44 | save_path = path_to_results+"/res_{}.mat".format(NUM) 45 | save_path_txt = path_to_results+"/res_{}.txt".format(NUM) 46 | 47 | # }}} 48 | # ============================================================== # 49 | with open(path_to_results + "/params.json") as h: 50 | config = json.loads(h.read()) 51 | 52 | env_config = config["env_config"] 53 | 54 | # find all checkpoint and load the latest 55 | filenames = os.listdir(path_to_results) 56 | checkpoint_numbers = [] 57 | for fn in filenames: 58 | m = re.findall('checkpoint_(\d+)', fn) 59 | if not m: continue 60 | print(m[0]) 61 | checkpoint_numbers.append(int(m[0])) 62 | 63 | mc = max(checkpoint_numbers) 64 | checkpoint_path = path_to_results+"/"+"checkpoint_{}/checkpoint-{}".format(mc,mc) 65 | print("found {} checkpoints".format(len(checkpoint_numbers))) 66 | print("restoring "+checkpoint_path) 67 | 68 | # ============================================================== # 69 | # evaluation {{{ 70 | # ============================================================== # 71 | #ray.init() 72 | ray.init(temp_dir=tmpdir+"/ray") # you may need to change the temp directory in case it runs on a cluster or shared machine 73 | 74 | if config["optimizer_class"] == "AsyncReplayOptimizer": 75 | trainer = dqn.ApexTrainer(config=config, env=CodeEnv) 76 | else: 77 | trainer = dqn.DQNTrainer(config=config, env=CodeEnv) 78 | trainer.restore(checkpoint_path) 79 | env = CodeEnv(env_config) 80 | n = env.n 81 | 82 | dB_len = len(dB_range) 83 | BitErr = np.zeros([dB_len], dtype=int) 84 | CwErr = np.zeros([dB_len], dtype=int) 85 | totCw = np.zeros([dB_len], dtype=int) 86 | totBit = np.zeros([dB_len], dtype=int) 87 | 88 | for i in range(dB_len): 89 | print("\n--------\nSimulating EbNo = {} dB".format(dB_range[i])) 90 | env.set_EbNo_dB(dB_range[i]) 91 | 92 | while(CwErr[i] 0: 104 | CwErr[i] = CwErr[i] + 1 105 | 106 | totCw[i] += 1 107 | totBit[i] += n 108 | 109 | print("CwErr:", CwErr[i]) 110 | print("BitErr:", BitErr[i]) 111 | print("TotCw:", totCw[i]) 112 | print("CER:", CwErr[i]/totCw[i]) 113 | print("BER:", BitErr[i]/totBit[i]) 114 | 115 | if SAVE: 116 | resdict = { 117 | "dB_range": dB_range, 118 | "CwErr": CwErr, 119 | "BitErr": BitErr, 120 | "TotCw": totCw, 121 | "TotBit": totBit, 122 | } 123 | 124 | print("\n****\nSaving files to:\n.mat -->"+save_path+"\n.txt -->"+save_path_txt) 125 | sio.savemat(save_path, resdict) 126 | with open(save_path_txt, 'w') as file_txt: 127 | file_txt.write(str(resdict)) 128 | 129 | ray.shutdown() 130 | 131 | print("done!") 132 | 133 | # }}} 134 | # ============================================================== # 135 | -------------------------------------------------------------------------------- /jobscript: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | echo process ID: $$ 3 | echo $$ > last_pid 4 | tic=$(date +%s) 5 | dB_range=[1,2,3,4,5,6,7,8] 6 | minCwErr=200 7 | maxCw=1000000 8 | resultPath="/home/fc94/RL_source/ray_results/CodeEnv/APEX_CodeEnv_0_2019-07-12_10-29-3546gmngz9" 9 | 10 | ####### Parallelization of test task 11 | # 3 processes consume >20 GB memory 12 | # for NUM in {1..2}; do 13 | # python3 eval.py $dB_range $minCwErr $maxCw $NUM --path=$resultPath --save & 14 | # sleep 0.1 15 | # done 16 | 17 | ####### Single test process 18 | NUM=1 19 | python3 eval.py $dB_range $minCwErr $maxCw $NUM --path=$resultPath --save & 20 | 21 | 22 | wait 23 | toc=$(date +%s) 24 | sec=$(expr $toc - $tic) 25 | min=$(expr $sec / 60) 26 | echo Elapsed time: $sec -------------------------------------------------------------------------------- /kill_last_pid: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | kill -9 -`cat last_pid` 3 | # pgrep ray_worker 4 | # pkill -9 -f "ray_worker" -------------------------------------------------------------------------------- /last_pid: -------------------------------------------------------------------------------- 1 | 69816 2 | -------------------------------------------------------------------------------- /opt.py: -------------------------------------------------------------------------------- 1 | # ============================================================== # 2 | # imports {{{ 3 | # ============================================================== # 4 | import sys 5 | import ray 6 | import ray.rllib.agents.dqn as dqn 7 | from ray.rllib.utils import merge_dicts 8 | from ray.rllib.agents.trainer import with_common_config 9 | from ray import tune 10 | from CodeEnv import * 11 | # }}} 12 | # ============================================================== # 13 | # config {{{ 14 | # ============================================================== # 15 | 16 | codedir = "/home/fc94/RL_source" 17 | tmpdir = "/tmp/fc94" 18 | 19 | config = with_common_config( 20 | { 21 | "env_config": { 22 | "code" : "RM_2_5_std", # Select code 23 | #"code" : "BCH_63_45_oc", # Example of other code 24 | "EbNo_dB" : 4, # training SNR 25 | "maxIter" : 10, # maximum iterations (agent's life) 26 | "WBF" : False, # weighted bit-flipping 27 | "asort" : True, # automorphism sort 28 | "path_to_Hmat" : codedir + "/Hmat" 29 | }, 30 | "env": CodeEnv, 31 | "log_level": "WARN", 32 | 33 | # === Model === 34 | # Number of atoms for representing the distribution of return. When 35 | # this is greater than 1, distributional Q-learning is used. 36 | # the discrete supports are bounded by v_min and v_max 37 | "num_atoms": 1, 38 | "v_min": -10.0, 39 | "v_max": 10.0, 40 | "noisy": False, # Whether to use noisy network 41 | "sigma0": 0.5, # control the initial value of noisy nets 42 | "dueling": False, # Use dueling network 43 | "double_q": False, # Use double Q-learning 44 | # Postprocess model outputs with these hidden layers to compute the 45 | # state and action values. See also the model config in catalog.py. 46 | #"hiddens": [256], 47 | "n_step": 1, # N-step Q learning 48 | "model": { 49 | "fcnet_activation": "relu", 50 | #"fcnet_activation": tune.grid_search(["tanh", "relu"]), 51 | "fcnet_hiddens": [500], 52 | #"fcnet_hiddens": tune.grid_search([[1500],[1000],[500]]), 53 | # "l2_reg": 1e-6, 54 | }, 55 | 56 | # see https://github.com/ray-project/ray/blob/cff08e19ff1606ef6e718624703e8e0da19b223d/python/ray/rllib/agents/dqn/dqn.py#L257-L261 57 | "timesteps_per_iteration": 1000, # Number of env steps to optimize for before returning 58 | # one optimiziation step uses batch.count env steps for DQN 59 | "min_iter_time_s": 10, # prevent iterations from going lower than this time span 60 | 61 | # === Exploration === 62 | # Max num timesteps for annealing schedules. Exploration is annealed from 63 | # 1.0 to exploration_final_eps over this number of timesteps multiplied by 64 | # exploration_fraction 65 | "schedule_max_timesteps": 2500000, 66 | # Fraction of entire training period over which the exploration rate is 67 | # annealed 68 | "exploration_fraction": 0.9, 69 | # Final value of random action probability 70 | "exploration_final_eps": 0.0, 71 | # Update the target network every `target_network_update_freq` steps. 72 | "target_network_update_freq": 50000, 73 | # Use softmax for sampling actions. Required for off policy estimation. 74 | #"soft_q": tune.grid_search([True, False]), 75 | "soft_q": False, 76 | # Softmax temperature. Q values are divided by this value prior to softmax. 77 | # Softmax approaches argmax as the temperature drops to zero. 78 | "softmax_temp": 1.0, 79 | # If True parameter space noise will be used for exploration 80 | # See https://blog.openai.com/better-exploration-with-parameter-noise/ 81 | "parameter_noise": False, 82 | 83 | # === Replay buffer === 84 | # Size of the replay buffer. Note that if async_updates is set, then 85 | # each worker will have a replay buffer of this size. 86 | #"buffer_size": 200000, 87 | "buffer_size": 10000, 88 | # If True prioritized replay buffer will be used. 89 | #"prioritized_replay": tune.grid_search([True, False]), 90 | "prioritized_replay": False, 91 | # Alpha parameter for prioritized replay buffer. 92 | "prioritized_replay_alpha": 0.6, 93 | # Beta parameter for sampling from prioritized replay buffer. 94 | "prioritized_replay_beta": 0.4, 95 | # Fraction of entire training period over which the beta parameter is 96 | # annealed 97 | "beta_annealing_fraction": 0.2, 98 | # Final value of beta 99 | "final_prioritized_replay_beta": 0.4, 100 | # Epsilon to add to the TD errors when updating priorities. 101 | "prioritized_replay_eps": 1e-6, 102 | # Whether to LZ4 compress observations 103 | "compress_observations": True, 104 | 105 | # === Optimization === 106 | # Learning rate for adam optimizer 107 | "lr": 0.0001, 108 | #"lr": tune.grid_search([0.0001, 0.00007]), 109 | # Learning rate schedule 110 | "lr_schedule": None, 111 | # Adam epsilon hyper parameter 112 | "adam_epsilon": 1e-8, 113 | "grad_norm_clipping": 40, # If not None, clip gradients during optimization at this value 114 | "learning_starts": 1000, # How many steps of the model to sample before learning starts. 115 | # Update the replay buffer with this many samples at once. Note that 116 | # this setting applies per-worker if num_workers > 1. 117 | "sample_batch_size": 50, # APEX 118 | #"sample_batch_size": 4, 119 | # Size of a batched sampled from replay buffer for training. Note that 120 | # if async_updates is set, then each worker returns gradients for a 121 | # batch of this size. 122 | "train_batch_size": 32, 123 | #"train_batch_size": tune.grid_search([32, 64]), 124 | 125 | # === Parallelism === 126 | # Number of workers for collecting samples with. This only makes sense 127 | # to increase if your environment is particularly slow to sample, or if 128 | # you"re using the Async or Ape-X optimizers. 129 | "num_gpus": 1, 130 | "num_workers": 10, 131 | #"num_gpus": 1, # APEX 132 | #"num_workers": 10, # APEX 133 | # "optimizer_class": "SyncReplayOptimizer", # Optimizer class to use. 134 | # APEX 135 | "optimizer_class": "AsyncReplayOptimizer", # for APEX / does not work with DQN (only APEX) 136 | "optimizer": { 137 | "max_weight_sync_delay": 2000, 138 | "num_replay_buffer_shards": 5, # increasing this increases GPU usage 139 | "debug": False 140 | }, 141 | "per_worker_exploration": False, # Whether to use a distribution of epsilons across workers for exploration. 142 | #"per_worker_exploration": True, # APEX 143 | # Whether to compute priorities on workers. 144 | "worker_side_prioritization": False, 145 | #"worker_side_prioritization": True, #APEX 146 | }, 147 | ) 148 | 149 | # }}} 150 | # ============================================================== # 151 | # run optimizations {{{ 152 | # ============================================================== # 153 | #ray.init() 154 | ray.init(temp_dir=tmpdir+"/ray") # you may need to change the temp directory in case it runs on a cluster or shared machine 155 | 156 | 157 | tune.run( 158 | "APEX", 159 | #"DQN", 160 | name="CodeEnv", 161 | checkpoint_at_end=True, 162 | num_samples=1, 163 | local_dir=codedir+"/ray_results", 164 | #stop={"episode_reward_mean": 10}, 165 | stop={"training_iteration": 150}, 166 | config=config 167 | ) 168 | 169 | ray.shutdown() 170 | 171 | print("done!") 172 | # }}} 173 | # ============================================================== # 174 | -------------------------------------------------------------------------------- /optscript: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | echo process ID: $$ 3 | echo $$ > last_pid 4 | tic=$(date +%s) 5 | python3 opt.py 6 | toc=$(date +%s) 7 | sec=$(expr $toc - $tic) 8 | min=$(expr $sec / 60) 9 | echo Elapsed time: $sec -------------------------------------------------------------------------------- /rllib.yml: -------------------------------------------------------------------------------- 1 | name: rllib 2 | channels: 3 | - conda-forge 4 | dependencies: 5 | - python 6 | - pip 7 | - cudatoolkit==9.0 8 | - tensorflow-gpu==1.12.0 9 | - pip: 10 | - gym[atari] 11 | - ray[rllib]==0.6.6 -------------------------------------------------------------------------------- /utils.py: -------------------------------------------------------------------------------- 1 | import numpy as np 2 | 3 | def find_cyclic_auto(llr, k): 4 | """ 5 | The automorphism group of primitive, narrow-sense binary BCH codes (blocklength N = 2^m-1) includes all permutations of the form 6 | 7 | pi_{i,j}(n) = 2^i * n + j mod N 8 | 9 | where i = {0,...,m-1} and n = {0,...,N-1}. For i=0, these are all cyclic shifts. 10 | 11 | """ 12 | N = len(llr) 13 | m = int(np.log2(N+1)) 14 | if 2**m-1 != N: 15 | print("length of LLR vector has to be N=2^m-1") 16 | 17 | absllr = abs(llr) 18 | err = np.exp(-absllr)/(1+np.exp(-absllr)) 19 | cap = np.log(2) + err*np.log(err) + (1-err)*np.log(1-err) 20 | 21 | # compute fft vector 22 | kfft = np.fft.fft(np.concatenate([np.ones(np.abs(k)), np.zeros(N-np.abs(k))])) 23 | if k<0: 24 | kfft = -kfft 25 | k = abs(k) 26 | 27 | # try all Frobenius automorphisms 28 | maxval = -1e5 29 | index = np.arange(N) 30 | 31 | for i in range(m): 32 | test = cap[ (2**i*index)%N ] 33 | b = np.real(np.fft.ifft(np.fft.fft(test)*kfft)) 34 | val = b.max() 35 | ind = (N-(k-1)+b.argmax()+1)%N 36 | 37 | if val>maxval: 38 | p = (2**i*index)%N 39 | p = p[(index+ind-1)%N] 40 | maxval = val 41 | 42 | return p 43 | 44 | def de2bi(d, n, MSBFLAG='right-msb'): 45 | # de2bi(np.arange(M), m) 46 | if isinstance(d, (list,)): 47 | d = np.array(d) 48 | elif type(d) is np.ndarray: 49 | d = d.flatten() 50 | else: 51 | d = np.array([d]) 52 | power = 2**np.arange(n) 53 | bitarray = (np.floor((d[:,None]%(2*power))/power)) 54 | if MSBFLAG == 'right-msb': 55 | return bitarray 56 | else: 57 | return np.fliplr(bitarray) 58 | 59 | def bi2de(B, MSBFLAG='right-msb'): 60 | """ 61 | converts a binary vector B to decimal value 62 | if B is a matrix, conversion is done row-wise 63 | """ 64 | if(len(B.shape) == 1): 65 | n = B.shape[0] 66 | B = np.expand_dims(B, 0) 67 | elif(len(B.shape) == 2): 68 | n = B.shape[1] 69 | else: 70 | print("this should not happen") 71 | 72 | if MSBFLAG == 'left-msb': 73 | B = np.fliplr(B) 74 | 75 | power = 2**np.arange(n) 76 | return (np.sum(B*power, 1)).astype(np.int32) 77 | 78 | def gfrref(A): 79 | """ 80 | Args: 81 | A: binary matrix 82 | 83 | Returns: 84 | R: reduced row echolon form of A (over GF(2)) 85 | jb: A[:,jb] is the basis for the range of A, lengh(rb) is the rank of A 86 | 87 | """ 88 | # reduced row echelon form in GF(2) 89 | (m, n), j = A.shape, 0 90 | Ar, rank = np.hstack([A, np.eye(m)]), 0 91 | for i in range(min(m, n)): 92 | # Find value and index of non-zero element in the remainder of column i. 93 | while j < n: 94 | temp = np.where(Ar[i:, j] != 0)[0] 95 | if len(temp) == 0: 96 | # If the lower half of j-th row is all-zero, check next column 97 | j += 1 98 | else: 99 | # Swap i-th and k-th rows 100 | k, rank = temp[0] + i, rank + 1 101 | if i != k: 102 | Ar[[i, k], j:] = Ar[[k, i], j:] 103 | # Save the right hand side of the pivot row 104 | pivot = Ar[i, j] 105 | row = Ar[i, j:].reshape((1, -1)) * pivot**(-1) 106 | col = np.hstack([Ar[:i, j], [0], Ar[i + 1:, j]]).reshape((-1, 1)) 107 | Ar[:, j:] = (Ar[:, j:] - col * row) % 2 108 | Ar[i, j:] = Ar[i, j:] * pivot**(-1) % 2 109 | break 110 | j += 1 111 | R = Ar[:, :n] 112 | col_sum = R.sum(axis=0) 113 | jb = np.where(col_sum == 1)[0] 114 | return R, jb 115 | #perm = np.concatenate([, np.where(col_sum > 1)[0]]) 116 | #R, Y = Ar[:, :n], Ar[:, n:] 117 | #return R, Y, rank 118 | 119 | def gfrank(A): 120 | _, jb = gfrref(A) 121 | return len(jb) 122 | 123 | 124 | def find_rm_auto(llr): 125 | """ 126 | This function returns an automorphism permutation for RM codes that 127 | maps as many as possible of the lowest llrs to positions 0,1,2,4,8... 128 | """ 129 | 130 | if isinstance(llr, (list,)): 131 | llr = np.array(llr) 132 | 133 | n = llr.shape[0] 134 | m = np.round(np.log2(n)) 135 | if(n != 2**m): 136 | raise ValueError("length not power of 2") 137 | 138 | sp = np.argsort(np.abs(llr)) 139 | 140 | offset = (de2bi(sp[0], m)).T 141 | A = ((de2bi(sp[1:], m)).T - offset) % 2 # permutation of all nonzero bit positions 142 | R, jb = gfrref(A) 143 | M = A[:, jb] 144 | 145 | # compute permutation 146 | B = (de2bi(np.arange(n), m)).T 147 | q = (np.matmul(M,B) + offset) % 2 148 | p = bi2de(q.T) 149 | 150 | return p 151 | --------------------------------------------------------------------------------