tensorflow-records (empty) → 0.1.0.0
raw patch · 6 files changed
+494/−0 lines, 6 filesdep +basedep +bytestringdep +cerealsetup-changed
Dependencies added: base, bytestring, cereal, snappy-framing, tensorflow-records, test-framework, test-framework-quickcheck2
Files
- LICENSE +203/−0
- Setup.hs +3/−0
- src/TensorFlow/CRC32C.hs +61/−0
- src/TensorFlow/Records.hs +134/−0
- tensorflow-records.cabal +42/−0
- tests/Main.hs +51/−0
+ LICENSE view
@@ -0,0 +1,203 @@+Copyright 2016 The TensorFlow Authors. All rights reserved.++ Apache License+ Version 2.0, January 2004+ http://www.apache.org/licenses/++ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION++ 1. Definitions.++ "License" shall mean the terms and conditions for use, reproduction,+ and distribution as defined by Sections 1 through 9 of this document.++ "Licensor" shall mean the copyright owner or entity authorized by+ the copyright owner that is granting the License.++ "Legal Entity" shall mean the union of the acting entity and all+ other entities that control, are controlled by, or are under common+ control with that entity. For the purposes of this definition,+ "control" means (i) the power, direct or indirect, to cause the+ direction or management of such entity, whether by contract or+ otherwise, or (ii) ownership of fifty percent (50%) or more of the+ outstanding shares, or (iii) beneficial ownership of such entity.++ "You" (or "Your") shall mean an individual or Legal Entity+ exercising permissions granted by this License.++ "Source" form shall mean the preferred form for making modifications,+ including but not limited to software source code, documentation+ source, and configuration files.++ "Object" form shall mean any form resulting from mechanical+ transformation or translation of a Source form, including but+ not limited to compiled object code, generated documentation,+ and conversions to other media types.++ "Work" shall mean the work of authorship, whether in Source or+ Object form, made available under the License, as indicated by a+ copyright notice that is included in or attached to the work+ (an example is provided in the Appendix below).++ "Derivative Works" shall mean any work, whether in Source or Object+ form, that is based on (or derived from) the Work and for which the+ editorial revisions, annotations, elaborations, or other modifications+ represent, as a whole, an original work of authorship. For the purposes+ of this License, Derivative Works shall not include works that remain+ separable from, or merely link (or bind by name) to the interfaces of,+ the Work and Derivative Works thereof.++ "Contribution" shall mean any work of authorship, including+ the original version of the Work and any modifications or additions+ to that Work or Derivative Works thereof, that is intentionally+ submitted to Licensor for inclusion in the Work by the copyright owner+ or by an individual or Legal Entity authorized to submit on behalf of+ the copyright owner. For the purposes of this definition, "submitted"+ means any form of electronic, verbal, or written communication sent+ to the Licensor or its representatives, including but not limited to+ communication on electronic mailing lists, source code control systems,+ and issue tracking systems that are managed by, or on behalf of, the+ Licensor for the purpose of discussing and improving the Work, but+ excluding communication that is conspicuously marked or otherwise+ designated in writing by the copyright owner as "Not a Contribution."++ "Contributor" shall mean Licensor and any individual or Legal Entity+ on behalf of whom a Contribution has been received by Licensor and+ subsequently incorporated within the Work.++ 2. Grant of Copyright License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ copyright license to reproduce, prepare Derivative Works of,+ publicly display, publicly perform, sublicense, and distribute the+ Work and such Derivative Works in Source or Object form.++ 3. Grant of Patent License. Subject to the terms and conditions of+ this License, each Contributor hereby grants to You a perpetual,+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable+ (except as stated in this section) patent license to make, have made,+ use, offer to sell, sell, import, and otherwise transfer the Work,+ where such license applies only to those patent claims licensable+ by such Contributor that are necessarily infringed by their+ Contribution(s) alone or by combination of their Contribution(s)+ with the Work to which such Contribution(s) was submitted. If You+ institute patent litigation against any entity (including a+ cross-claim or counterclaim in a lawsuit) alleging that the Work+ or a Contribution incorporated within the Work constitutes direct+ or contributory patent infringement, then any patent licenses+ granted to You under this License for that Work shall terminate+ as of the date such litigation is filed.++ 4. Redistribution. You may reproduce and distribute copies of the+ Work or Derivative Works thereof in any medium, with or without+ modifications, and in Source or Object form, provided that You+ meet the following conditions:++ (a) You must give any other recipients of the Work or+ Derivative Works a copy of this License; and++ (b) You must cause any modified files to carry prominent notices+ stating that You changed the files; and++ (c) You must retain, in the Source form of any Derivative Works+ that You distribute, all copyright, patent, trademark, and+ attribution notices from the Source form of the Work,+ excluding those notices that do not pertain to any part of+ the Derivative Works; and++ (d) If the Work includes a "NOTICE" text file as part of its+ distribution, then any Derivative Works that You distribute must+ include a readable copy of the attribution notices contained+ within such NOTICE file, excluding those notices that do not+ pertain to any part of the Derivative Works, in at least one+ of the following places: within a NOTICE text file distributed+ as part of the Derivative Works; within the Source form or+ documentation, if provided along with the Derivative Works; or,+ within a display generated by the Derivative Works, if and+ wherever such third-party notices normally appear. The contents+ of the NOTICE file are for informational purposes only and+ do not modify the License. You may add Your own attribution+ notices within Derivative Works that You distribute, alongside+ or as an addendum to the NOTICE text from the Work, provided+ that such additional attribution notices cannot be construed+ as modifying the License.++ You may add Your own copyright statement to Your modifications and+ may provide additional or different license terms and conditions+ for use, reproduction, or distribution of Your modifications, or+ for any such Derivative Works as a whole, provided Your use,+ reproduction, and distribution of the Work otherwise complies with+ the conditions stated in this License.++ 5. Submission of Contributions. Unless You explicitly state otherwise,+ any Contribution intentionally submitted for inclusion in the Work+ by You to the Licensor shall be under the terms and conditions of+ this License, without any additional terms or conditions.+ Notwithstanding the above, nothing herein shall supersede or modify+ the terms of any separate license agreement you may have executed+ with Licensor regarding such Contributions.++ 6. Trademarks. This License does not grant permission to use the trade+ names, trademarks, service marks, or product names of the Licensor,+ except as required for reasonable and customary use in describing the+ origin of the Work and reproducing the content of the NOTICE file.++ 7. Disclaimer of Warranty. Unless required by applicable law or+ agreed to in writing, Licensor provides the Work (and each+ Contributor provides its Contributions) on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or+ implied, including, without limitation, any warranties or conditions+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A+ PARTICULAR PURPOSE. You are solely responsible for determining the+ appropriateness of using or redistributing the Work and assume any+ risks associated with Your exercise of permissions under this License.++ 8. Limitation of Liability. In no event and under no legal theory,+ whether in tort (including negligence), contract, or otherwise,+ unless required by applicable law (such as deliberate and grossly+ negligent acts) or agreed to in writing, shall any Contributor be+ liable to You for damages, including any direct, indirect, special,+ incidental, or consequential damages of any character arising as a+ result of this License or out of the use or inability to use the+ Work (including but not limited to damages for loss of goodwill,+ work stoppage, computer failure or malfunction, or any and all+ other commercial damages or losses), even if such Contributor+ has been advised of the possibility of such damages.++ 9. Accepting Warranty or Additional Liability. While redistributing+ the Work or Derivative Works thereof, You may choose to offer,+ and charge a fee for, acceptance of support, warranty, indemnity,+ or other liability obligations and/or rights consistent with this+ License. However, in accepting such obligations, You may act only+ on Your own behalf and on Your sole responsibility, not on behalf+ of any other Contributor, and only if You agree to indemnify,+ defend, and hold each Contributor harmless for any liability+ incurred by, or claims asserted against, such Contributor by reason+ of your accepting any such warranty or additional liability.++ END OF TERMS AND CONDITIONS++ APPENDIX: How to apply the Apache License to your work.++ To apply the Apache License to your work, attach the following+ boilerplate notice, with the fields enclosed by brackets "[]"+ replaced with your own identifying information. (Don't include+ the brackets!) The text should be enclosed in the appropriate+ comment syntax for the file format. We also recommend that a+ file or class name and description of purpose be included on the+ same "printed page" as the copyright notice for easier+ identification within third-party archives.++ Copyright 2016, The TensorFlow 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++ Unless required by applicable law or agreed to in writing, software+ distributed under the License is distributed on an "AS IS" BASIS,+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+ See the License for the specific language governing permissions and+ limitations under the License.
+ Setup.hs view
@@ -0,0 +1,3 @@+import Distribution.Simple++main = defaultMain
+ src/TensorFlow/CRC32C.hs view
@@ -0,0 +1,61 @@+-- Copyright 2016 TensorFlow 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+--+-- Unless required by applicable law or agreed to in writing, software+-- distributed under the License is distributed on an "AS IS" BASIS,+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+-- See the License for the specific language governing permissions and+-- limitations under the License.++module TensorFlow.CRC32C+ ( crc32c+ , crc32cLBS+ , crc32cUpdate+ , crc32cMasked+ , crc32cLBSMasked+ , crc32cMask+ , crc32cUnmask+ ) where++import Data.Bits (rotateL, rotateR)+import qualified Data.ByteString as B+import qualified Data.ByteString.Lazy as BL+import Data.Digest.CRC32C (crc32c, crc32c_update)+import Data.List (foldl')+import Data.Word (Word32)++-- | Compute the CRC32C checksum of the concatenation of the bytes checksummed+-- by the given CRC32C value and the bytes in the given ByteString.+crc32cUpdate :: Word32 -> B.ByteString -> Word32+crc32cUpdate = crc32c_update++-- | Compute the CRC32C checksum of the given bytes.+crc32cLBS :: BL.ByteString -> Word32+crc32cLBS = foldl' crc32cUpdate 0 . BL.toChunks++-- | Scramble a CRC32C value so that the result can be safely stored in a+-- bytestream that may itself be CRC'd.+--+-- This masking is the algorithm specified by TensorFlow's TFRecords format.+crc32cMask :: Word32 -> Word32+crc32cMask x = rotateR x 15 + maskDelta++-- | Inverse of 'crc32cMask'.+crc32cUnmask :: Word32 -> Word32+crc32cUnmask x = rotateL (x - maskDelta) 15++-- | Convenience function combining 'crc32c' and 'crc32cMask'.+crc32cMasked :: B.ByteString -> Word32+crc32cMasked = crc32cMask . crc32c++-- | Convenience function combining 'crc32cLBS' and 'crc32cMask'.+crc32cLBSMasked :: BL.ByteString -> Word32+crc32cLBSMasked = crc32cMask . crc32cLBS++maskDelta :: Word32+maskDelta = 0xa282ead8
+ src/TensorFlow/Records.hs view
@@ -0,0 +1,134 @@+-- Copyright 2016 TensorFlow 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+--+-- Unless required by applicable law or agreed to in writing, software+-- distributed under the License is distributed on an "AS IS" BASIS,+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+-- See the License for the specific language governing permissions and+-- limitations under the License.++-- | Encoder and decoder for the TensorFlow \"TFRecords\" format.++{-# LANGUAGE Rank2Types #-}+module TensorFlow.Records+ (+ -- * Records+ putTFRecord+ , getTFRecord+ , getTFRecords++ -- * Implementation++ -- | These may be useful for encoding or decoding to types other than+ -- 'ByteString' that have their own Cereal codecs.+ , getTFRecordLength+ , getTFRecordData+ , putTFRecordLength+ , putTFRecordData+ ) where++import Control.Exception (evaluate)+import Control.Monad (when)+import Data.ByteString.Unsafe (unsafePackCStringLen)+import qualified Data.ByteString.Builder as B (Builder)+import Data.ByteString.Builder.Extra (runBuilder, Next(..))+import qualified Data.ByteString.Lazy as BL+import Data.Serialize.Get+ ( Get+ , getBytes+ , getWord32le+ , getWord64le+ , getLazyByteString+ , isEmpty+ , lookAhead+ )+import Data.Serialize+ ( Put+ , execPut+ , putLazyByteString+ , putWord32le+ , putWord64le+ )+import Data.Word (Word8, Word64)+import Foreign.Marshal.Alloc (allocaBytes)+import Foreign.Ptr (Ptr, castPtr)+import System.IO.Unsafe (unsafePerformIO)++import TensorFlow.CRC32C (crc32cLBSMasked, crc32cUpdate, crc32cMask)++-- | Parse one TFRecord.+getTFRecord :: Get BL.ByteString+getTFRecord = getTFRecordLength >>= getTFRecordData++-- | Parse many TFRecords as a list. Note you probably want streaming instead+-- as provided by the tensorflow-records-conduit package.+getTFRecords :: Get [BL.ByteString]+getTFRecords = do+ e <- isEmpty+ if e then return [] else (:) <$> getTFRecord <*> getTFRecords++getCheckMaskedCRC32C :: BL.ByteString -> Get ()+getCheckMaskedCRC32C bs = do+ wireCRC <- getWord32le+ let maskedCRC = crc32cLBSMasked bs+ when (maskedCRC /= wireCRC) $ fail $+ "getCheckMaskedCRC32C: CRC mismatch, computed: " ++ show maskedCRC +++ ", expected: " ++ show wireCRC++-- | Get a length and verify its checksum.+getTFRecordLength :: Get Word64+getTFRecordLength = do+ buf <- lookAhead (getBytes 8)+ getWord64le <* getCheckMaskedCRC32C (BL.fromStrict buf)++-- | Get a record payload and verify its checksum.+getTFRecordData :: Word64 -> Get BL.ByteString+getTFRecordData len = if len > 0x7fffffffffffffff+ then fail "getTFRecordData: Record size overflows Int64"+ else do+ bs <- getLazyByteString (fromIntegral len)+ getCheckMaskedCRC32C bs+ return bs++putMaskedCRC32C :: BL.ByteString -> Put+putMaskedCRC32C = putWord32le . crc32cLBSMasked++-- Runs a Builder that's known to write a fixed number of bytes on an 'alloca'+-- buffer, and runs the given IO action on the result. Raises exceptions if+-- the Builder yields ByteString chunks or attempts to write more bytes than+-- expected.+unsafeWithFixedWidthBuilder :: Int -> B.Builder -> (Ptr Word8 -> IO r) -> IO r+unsafeWithFixedWidthBuilder n b act = allocaBytes n $ \ptr -> do+ (_, signal) <- runBuilder b ptr n+ case signal of+ Done -> act ptr+ More _ _ -> error "unsafeWithFixedWidthBuilder: Builder returned More."+ Chunk _ _ -> error "unsafeWithFixedWidthBuilder: Builder returned Chunk."++-- | Put a record length and its checksum.+putTFRecordLength :: Word64 -> Put+putTFRecordLength x =+ let put = putWord64le x+ len = 8+ crc = crc32cMask $ unsafePerformIO $+ -- Serialized Word64 is always 8 bytes, so we can go fast by using+ -- alloca.+ unsafeWithFixedWidthBuilder len (execPut put) $ \ptr -> do+ str <- unsafePackCStringLen (castPtr ptr, len)+ -- Force the result to ensure it's evaluated before freeing ptr.+ evaluate $ crc32cUpdate 0 str+ in put *> putWord32le crc++-- | Put a record payload and its checksum.+putTFRecordData :: BL.ByteString -> Put+putTFRecordData bs = putLazyByteString bs *> putMaskedCRC32C bs++-- | Put one TFRecord with the given contents.+putTFRecord :: BL.ByteString -> Put+putTFRecord bs =+ putTFRecordLength (fromIntegral $ BL.length bs) *> putTFRecordData bs
+ tensorflow-records.cabal view
@@ -0,0 +1,42 @@+name: tensorflow-records+version: 0.1.0.0+synopsis: Encoder and decoder for the TensorFlow \"TFRecords\" format.+description: Encoder and decoder for the TensorFlow \"TFRecords\" format.+homepage: https://github.com/tensorflow/haskell#readme+license: Apache+license-file: LICENSE+author: TensorFlow authors+maintainer: tensorflow-haskell@googlegroups.com+copyright: Google Inc.+category: Machine Learning+build-type: Simple+cabal-version: >=1.22++library+ hs-source-dirs: src+ exposed-modules: TensorFlow.Records+ other-modules: TensorFlow.CRC32C+ build-depends: base >= 4.7 && < 5+ , bytestring+ , cereal+ -- TODO: Split Data.Digest.CRC32C out of snappy-framing for a+ -- lighter dependency?+ , snappy-framing >= 0.1.1+ default-language: Haskell2010++Test-Suite RecordsTest+ default-language: Haskell2010+ type: exitcode-stdio-1.0+ main-is: Main.hs+ hs-source-dirs: tests+ build-depends: base+ , bytestring+ , cereal+ , tensorflow-records+ , test-framework+ , test-framework-quickcheck2+++source-repository head+ type: git+ location: https://github.com/tensorflow/haskell
+ tests/Main.hs view
@@ -0,0 +1,51 @@+-- Copyright 2016 TensorFlow 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+--+-- Unless required by applicable law or agreed to in writing, software+-- distributed under the License is distributed on an "AS IS" BASIS,+-- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.+-- See the License for the specific language governing permissions and+-- limitations under the License.++{-# LANGUAGE OverloadedStrings #-}+module Main where++import qualified Data.ByteString as B+import qualified Data.ByteString.Lazy as BL+import Data.Monoid ((<>))+import Data.Word (Word8)+import Data.Serialize (runGet, runPut)+import Test.Framework (Test, defaultMain)+import Test.Framework.Providers.QuickCheck2 (testProperty)++import TensorFlow.Records (getTFRecord, putTFRecord)++main :: IO ()+main = defaultMain tests++tests :: [Test]+tests =+ [ testProperty "Inverse" propEncodeDecodeInverse+ , testProperty "FixedRecord" propFixedRecord+ ]++-- There's no (Arbitrary BL.ByteString), so pack it from a list of chunks.+propEncodeDecodeInverse :: [[Word8]] -> Bool+propEncodeDecodeInverse s =+ let bs = BL.fromChunks . fmap B.pack $ s+ in runGet getTFRecord (runPut (putTFRecord bs)) == Right bs++propFixedRecord :: Bool+propFixedRecord =+ ("\x42" == case runGet getTFRecord record of+ Left err -> error err -- Make the error appear in the test failure.+ Right x -> x) &&+ (runPut (putTFRecord "\x42") == record)+ where+ record = "\x01\x00\x00\x00\x00\x00\x00\x00" <> "\x01\x75\xde\x41" <>+ "\x42" <> "\x52\xcf\xb8\x1e"