From e127b088bb87adeaf15d31a68542e4cd8d0fa567 Mon Sep 17 00:00:00 2001 From: Benjamin Lefaudeux Date: Mon, 16 Sep 2024 13:53:32 +0200 Subject: [PATCH] Decent starting point --- .github/workflows/go.yml | 38 ++ LICENSE | 695 ++--------------------------------- MANIFEST.in | 5 + README.md | 163 +++++++- generate_python_package.sh | 26 ++ pyproject.toml | 18 + src/benchmark.py | 80 ++++ src/cmd/main/main.go | 87 +++++ src/go.mod | 15 + src/go.sum | 69 ++++ src/pkg/client/client.go | 536 +++++++++++++++++++++++++++ src/pkg/client/serdes.go | 301 +++++++++++++++ src/pkg/client/transforms.go | 113 ++++++ src/pkg/client/utils.go | 57 +++ src/polyglot.py | 66 ++++ src/tests/client_test.go | 221 +++++++++++ 16 files changed, 1814 insertions(+), 676 deletions(-) create mode 100644 .github/workflows/go.yml create mode 100644 MANIFEST.in create mode 100755 generate_python_package.sh create mode 100644 pyproject.toml create mode 100644 src/benchmark.py create mode 100644 src/cmd/main/main.go create mode 100644 src/go.mod create mode 100644 src/go.sum create mode 100644 src/pkg/client/client.go create mode 100644 src/pkg/client/serdes.go create mode 100644 src/pkg/client/transforms.go create mode 100644 src/pkg/client/utils.go create mode 100644 src/polyglot.py create mode 100644 src/tests/client_test.go diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml new file mode 100644 index 0000000..1020b2e --- /dev/null +++ b/.github/workflows/go.yml @@ -0,0 +1,38 @@ +# This workflow will build a golang project +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go + +name: Go + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - name: Set up Go + uses: actions/setup-go@v4 + with: + go-version: '1.20' + + - name: Install linux deps + run: | + sudo apt-get update + sudo apt-get -y install libvips-dev + + - name: Build + run: cd src/cmd/main && go build -v main.go + + - name: Test + env: + DATAROOM_API_KEY: ${{ secrets.DATAROOM_API_KEY }} + DATAROOM_TEST_SOURCE: ${{ secrets.DATAROOM_TEST_SOURCE }} + DATAROOM_API_URL: ${{ secrets.DATAROOM_API_URL }} + + run: cd src/tests && go test -v . diff --git a/LICENSE b/LICENSE index f288702..752b2c5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,21 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. +MIT License + +Copyright (c) 2024 Photoroom + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..f0177f0 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,5 @@ +include *.md +include *.py +include datago/*.h +include datago/*.c +include datago/*.so \ No newline at end of file diff --git a/README.md b/README.md index 20de7ae..ab3f487 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,161 @@ -# datago -A golang-based data loader which can be used from Python. Useful to interact with a typical VectorDB stack for machine learning purposes +[![Build & Test](https://github.com/Photoroom/datago/actions/workflows/go.yml/badge.svg)](https://github.com/Photoroom/datago/actions/workflows/go.yml) + +datago +====== + +A golang-based data loader which can be used from Python. Compatible with a soon-to-be open sourced VectorDB-enabled data stack, which exposes HTTP requests. + +Datago will handle, outside of the Python GIL +- per sample IO from object storage +- deserialization +- some optional vision processing (aligning different image payloads) +- serialization + +Samples are then exposed in the Python scope and ready for consumption, typically using PIL and Numpy base types. +Speed will be network dependent, but GB/s is relatively easily possible + +Datago can be rank and world-size aware, in which case the samples are dispatched depending on the samples hash. + +Screenshot 2024-09-24 at 9 39 44 PM + + +
Use it + +Use the package from Python +--------------------------- + +```python +from datago import datago + +# source, has/lacks attributes, has/lacks masks, has/lacks latents, metadata prefetch, sample prefetch, concurrent download +client = datago.GetClient( + source="SOURCE", + require_images=True, + has_attributes="", + lacks_attributes="", + has_masks="", + lacks_masks="", + has_latents="", + lacks_latents="", + crop_and_resize=True, + prefetch_buffer_size=64, + samples_buffer_size=64, + downloads_concurrency=64, + ) + +client.Start() # This can be done early for convenience, not mandatory (can fetch samples while models are instanciated for intance) + +for _ in range(10): + sample = client.GetSample() # This start the client if not previously done, in that case latency for the first sample is higher +``` + +Please note that the image buffers will be passed around as raw pointers, they can be re-interpreted in python with the attached helpers + + +Match the raw exported buffers with typical python types +-------------------------------------------------------- + +See helper functions provided in `polyglot.py`, should be self explanatory + +
Build it + +Install deps +------------ + +```bash +$ sudo apt install golang libjpeg-turbo8-dev libvips-dev +$ sudo ldconfig +``` + +Build a benchmark CLI +--------------------- + +From the root of this project `datago_src`: + +```bash +$ go build cmd/main/main.go +``` + +Running it: + +```bash +$ ./main --help` will tell you all about it +``` + +Running it with additional sanity checks + +```bash +$ go run -race cmd/main/main.go +``` + +Run the go test suite +--------------------- + +From the src folder + +```bash +$ go test -v tests/client_test.go +``` + +Refresh the python package and its binaries +------------------------------------------- + +- Install the dependencies as detailed in the next point +- Run the `generate_python_package.sh` script + +Generate the python package binaries manually +--------------------------------------------- + +```bash +$ python3 -m pip install pybindgen +$ go install golang.org/x/tools/cmd/goimports@latest +$ go install github.com/go-python/gopy@latest +$ go install golang.org/x/image/draw +``` + +NOTE: +- you may need to add `~/go/bin` to your PATH so that gopy is found. +- - Either `export PATH=$PATH:~/go/bin` or add it to your .bashrc +- you may need this to make sure that LDD looks at the current folder `export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:.` + +then from the /pkg/client folder: + +```bash +$ gopy pkg -author="Photoroom" -email="team@photoroom.com" -url="" -name="datago" -version="0.0.1" . +``` + +then you can `pip install -e .` from here. + + +Update the pypi release (maintainers) +------------------------------------- +``` +python3 setup.py sdist +python3 -m twine upload dist/* --verbose +``` +
+ + +License +======= + MIT License + + Copyright (c) 2024 Photoroom + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in all + copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. diff --git a/generate_python_package.sh b/generate_python_package.sh new file mode 100755 index 0000000..2839eb2 --- /dev/null +++ b/generate_python_package.sh @@ -0,0 +1,26 @@ +#!/usr/bin/zsh + +echo "Updating the datago binaries" + +# Get the current python version +python_version=$(python3 --version 2>&1 | awk '{print $2}' | cut -d. -f1,2) +echo "Building package for python" $python_version + +# Setup where the python package will be copied +DESTINATION="../../../python_$python_version" +rm -rf $DESTINATION + +# Build the python package via the gopy toolchain +cd src/pkg/client +gopy pkg -author="Photoroom" -email="team@photoroom.com" -url="" -name="datago" -version="0.3" . +mkdir -p $DESTINATION/datago +mv datago/* $DESTINATION/datago/. +mv setup.py $DESTINATION/. +mv Makefile $DESTINATION/. +mv README.md $DESTINATION/. +rm LICENSE +rm MANIFEST.in + +cd ../../.. + + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..b8a1ca7 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,18 @@ +[project] +name = "datago_blefaudeux" +version = "0.0.1" +authors = [ + { name="Photoroom", email="team@photoroom.com" }, +] +description = "A high performance python module to access data ressources through HTTP, written in Golang" +readme = "README.md" +requires-python = "==3.11" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: MIT License", + "Operating System :: OS Independent", +] + +[project.urls] +Homepage = "https://github.com/photoroom/datago" +Issues = "https://github.com/photoroom/datago/issues" \ No newline at end of file diff --git a/src/benchmark.py b/src/benchmark.py new file mode 100644 index 0000000..85d9f6b --- /dev/null +++ b/src/benchmark.py @@ -0,0 +1,80 @@ +from datago import datago # type: ignore +import time +import typer +from tqdm import tqdm +import numpy as np +from polyglot import go_array_to_pil_image, go_array_to_numpy + + +def benchmark( + source: str = typer.Option("SOURCE", help="The source to test out"), + limit: int = typer.Option(2000, help="The number of samples to test on"), + crop_and_resize: bool = typer.Option(True, help="Crop and resize the images on the fly"), + require_images: bool = typer.Option(True, help="Request the original images"), + require_embeddings: bool = typer.Option(False, help="Request embeddings"), + test_masks: bool = typer.Option(True, help="Test masks"), + test_latents: bool = typer.Option(True, help="Test latents"), +): + print(f"Running benchmark for {source} - {limit} samples") + client = datago.GetClient( + source=source, + require_images=require_images, + require_embeddings=require_embeddings, + has_attributes="", + lacks_attributes="", + has_masks="segmentation_mask" if test_masks else "", + lacks_masks="", + has_latents="masked_image,my_test_latents" if test_latents else "", + lacks_latents="", + crop_and_resize=crop_and_resize, + prefetch_buffer_size=256, + samples_buffer_size=256, + downloads_concurrency=64, + ) + client.Start() + start = time.time() + + # Make sure in the following that we compare apples to apples, meaning in that case + # that we materialize the payloads in the python scope in the expected format + # (PIL.Image for images and masks for instance, numpy arrays for latents) + img, mask, masked_image = None, None, None + for _ in tqdm(range(limit), dynamic_ncols=True): + sample = client.GetSample() + if sample.ID: + # Bring the masks and image to PIL + if hasattr(sample, "Image"): + img = go_array_to_pil_image(sample.Image) + + if hasattr(sample, "Masks"): + for _, mask_buffer in sample.Masks.items(): + mask = go_array_to_pil_image(mask_buffer) + + if hasattr(sample, "AdditionalImages") and "masked_image" in sample.AdditionalImages: + masked_image = go_array_to_pil_image(sample.AdditionalImages["masked_image"]) + + # Bring the latents to numpy + if hasattr(sample, "Latents"): + for _, latent_buffer in sample.Latents.items(): + _latents = go_array_to_numpy(latent_buffer) + + # Bring the embeddings to numpy + if hasattr(sample, "CocaEmbedding"): + _embedding = np.array(sample.CocaEmbedding) + + fps = limit / (time.time() - start) + print(f"FPS {fps:.2f}") + client.Stop() + + # Save the last image as a test + if img is not None: + img.save("benchmark_last_image.png") + + if mask is not None: + mask.save("benchmark_last_mask.png") + + if masked_image is not None: + masked_image.save("benchmark_last_masked_image.png") + + +if __name__ == "__main__": + typer.run(benchmark) diff --git a/src/cmd/main/main.go b/src/cmd/main/main.go new file mode 100644 index 0000000..6307f60 --- /dev/null +++ b/src/cmd/main/main.go @@ -0,0 +1,87 @@ +package main + +import ( + datago "datago/pkg/client" + "flag" + "fmt" + "os" + "runtime/pprof" + "runtime/trace" + "time" +) + +func main() { + // Define flags + client_config := datago.GetDefaultConfig() + client_config.DefaultImageSize = 1024 + client_config.DownsamplingRatio = 32 + + client_config.CropAndResize = *flag.Bool("crop_and_resize", false, "Whether to crop and resize the images and masks") + client_config.ConcurrentDownloads = *flag.Int("concurrency", 64, "The number of concurrent http requests to make") + client_config.PrefetchBufferSize = *flag.Int("item_fetch_buffer", 256, "The number of items to pre-load") + client_config.SamplesBufferSize = *flag.Int("item_ready_buffer", 128, "The number of items ready to be served") + + client_config.Sources = *flag.String("source", "GETTY", "The source for the items") + client_config.RequireImages = *flag.Bool("require_images", true, "Whether the items require images") + client_config.RequireEmbeddings = *flag.Bool("require_embeddings", false, "Whether the items require the DB embeddings") + + client_config.Tags = *flag.String("tags", "", "The tags to filter for") + client_config.TagsNE = *flag.String("tags__ne", "", "The tags that the samples should not have") + client_config.HasMasks = *flag.String("has_masks", "", "The masks to filter for") + client_config.HasLatents = *flag.String("has_latents", "", "The masks to filter for") + client_config.HasAttributes = *flag.String("has_attributes", "", "The attributes to filter for") + + client_config.LacksMasks = *flag.String("lacks_masks", "", "The masks to filter against") + client_config.LacksLatents = *flag.String("lacks_latents", "", "The masks to filter against") + client_config.LacksAttributes = *flag.String("lacks_attributes", "", "The attributes to filter against") + + limit := flag.Int("limit", 2000, "The number of items to fetch") + profile := flag.Bool("profile", false, "Whether to profile the code") + + // Parse the flags and instantiate the client + flag.Parse() + + dataroom_client := datago.GetClient(client_config) + + // Go-routine which will feed the sample data to the workers + // and fetch the next page + startTime := time.Now() // Record the start time + + if *profile { + fmt.Println("Profiling the code") + { + f, _ := os.Create("trace.out") + // read with go tool trace trace.out + + trace.Start(f) + defer trace.Stop() + } + { + f, _ := os.Create("cpu.prof") + // read with go tool pprof cpu.prof + pprof.StartCPUProfile(f) + defer pprof.StopCPUProfile() + } + } + + dataroom_client.Start() + + // Fetch all of the binary payloads as they become available + // NOTE: This is useless, just making sure that we empty the payloads channel + for i := 0; i < *limit; i++ { + sample := dataroom_client.GetSample() + if sample.ID == "" { + fmt.Printf("Error fetching sample") + break + } + } + + // Cancel the context to kill the goroutines + dataroom_client.Stop() + + // Calculate the elapsed time + elapsedTime := time.Since(startTime) + fps := float64(*limit) / elapsedTime.Seconds() + fmt.Printf("Total execution time: %.2f \n", elapsedTime.Seconds()) + fmt.Printf("Average fetch rate: %.2f fetches per second\n", fps) +} diff --git a/src/go.mod b/src/go.mod new file mode 100644 index 0000000..afe741f --- /dev/null +++ b/src/go.mod @@ -0,0 +1,15 @@ +module datago + +go 1.18 + +require golang.org/x/image v0.18.0 // indirect + +require ( + github.com/davidbyttow/govips/v2 v2.15.0 + github.com/go-python/gopy v0.4.10 +) + +require ( + golang.org/x/net v0.23.0 // indirect + golang.org/x/text v0.16.0 // indirect +) diff --git a/src/go.sum b/src/go.sum new file mode 100644 index 0000000..c06ec06 --- /dev/null +++ b/src/go.sum @@ -0,0 +1,69 @@ +github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= +github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= +github.com/davidbyttow/govips/v2 v2.15.0 h1:h3lF+rQElBzGXbQSSPqmE3XGySPhcQo2x3t5l/dZ+pU= +github.com/davidbyttow/govips/v2 v2.15.0/go.mod h1:3OQCHj0nf5Mnrplh5VlNvmx3IhJXyxbAoTJZPflUjmM= +github.com/go-python/gopy v0.4.10 h1:Ec3x+NTSzLsw9f6FTdDLwQCQlmlNmJIu4J6nSnyugqE= +github.com/go-python/gopy v0.4.10/go.mod h1:zMV/gSSYa9u/8Zp0WYR+L/z+kOIqIUtMg/a1/GRy5uw= +github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ= +github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI= +github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno= +github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= +github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= +github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= +github.com/stretchr/testify v1.6.1 h1:hDPOHmpOpP40lSULcqw7IrRb/u7w6RpDC9399XyoNd0= +github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= +github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY= +golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= +golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc= +golang.org/x/crypto v0.19.0/go.mod h1:Iy9bg/ha4yyC70EfRS8jz+B6ybOBKMaSxLj6P6oBDfU= +golang.org/x/crypto v0.21.0/go.mod h1:0BP7YvVV9gBbVKyeTG0Gyn+gZm94bibOW5BjDEYAOMs= +golang.org/x/image v0.10.0/go.mod h1:jtrku+n79PfroUbvDdeUWMAI+heR786BofxrbiSF+J0= +golang.org/x/image v0.18.0 h1:jGzIakQa/ZXI1I0Fxvaa9W7yP25TqT6cHIHn+6CqvSQ= +golang.org/x/image v0.18.0/go.mod h1:4yyo5vMFQjVjUcVk4jEQcU9MGy/rulF5WvUILseCM2E= +golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4= +golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs= +golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= +golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg= +golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c= +golang.org/x/net v0.6.0/go.mod h1:2Tu9+aMcznHK/AK1HMvgo6xiTLG5rD5rZLDS+rp2Bjs= +golang.org/x/net v0.10.0/go.mod h1:0qNGK6F8kojg2nk9dLZ2mShWaEBan6FAoqfSigmmuDg= +golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44= +golang.org/x/net v0.23.0 h1:7EYJ93RZ9vYSZAIb2x3lnuvqO5zneoD6IvWjuhfxjTs= +golang.org/x/net v0.23.0/go.mod h1:JKghWKKOSdJwpW2GEx0Ja7fmaKnMsbu+MWVZTokSYmg= +golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= +golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.8.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/sys v0.18.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= +golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= +golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= +golang.org/x/term v0.8.0/go.mod h1:xPskH00ivmX89bAKVGSKKtLOWNx2+17Eiy94tnKShWo= +golang.org/x/term v0.17.0/go.mod h1:lLRBjIVuehSbZlaOtGMbcMncT+aqLLLmKrsjNrUguwk= +golang.org/x/term v0.18.0/go.mod h1:ILwASektA3OnRv7amZ1xhE/KTR+u50pbXfZ03+6Nx58= +golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= +golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= +golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= +golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.9.0/go.mod h1:e1OnstbJyHTd6l/uOt8jFFHp6TRDWZR/bV3emEE/zU8= +golang.org/x/text v0.11.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE= +golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU= +golang.org/x/text v0.16.0 h1:a94ExnEXNtEwYLGJSIUxnWoxoRz/ZcCsV63ROupILh4= +golang.org/x/text v0.16.0/go.mod h1:GhwF1Be+LQoKShO3cGOHzqOgRrGaYc9AvblQOmPVHnI= +golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= +golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= +golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= +golang.org/x/tools v0.6.0/go.mod h1:Xwgl3UAJ/d3gWutnCtw505GrjyAbvKui8lOU390QaIU= +golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= +gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/check.v1 v1.0.0-20200902074654-038fdea0a05b/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo= +gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/src/pkg/client/client.go b/src/pkg/client/client.go new file mode 100644 index 0000000..b242ad2 --- /dev/null +++ b/src/pkg/client/client.go @@ -0,0 +1,536 @@ +package datago + +import ( + "context" + "encoding/json" + "fmt" + "io" + "log" + "net/http" + "os" + "runtime" + "runtime/debug" + "strings" + "sync" + "time" + + "github.com/davidbyttow/govips/v2/vips" +) + +// --- DB Communication structures --------------------------------------------------------------------------------------------------------------------------------------------------------------- +type URLLatent struct { + URL string `json:"file_direct_url"` + LatentType string `json:"latent_type"` + IsMask bool `json:"is_mask"` +} + +type SampleMetadata struct { + Id string `json:"id"` + Attributes map[string]interface{} `json:"attributes"` + ImageDirectURL string `json:"image_direct_url"` + Latents []URLLatent `json:"latents"` + Tags []string `json:"tags"` + CocaEmbedding struct { + Vector []float32 `json:"vector"` + } `json:"coca_embedding"` +} + +type Response struct { + Next string `json:"next"` + SampleMetadata []SampleMetadata `json:"results"` +} + +type PageRequest struct { + fields string + sources string + pageSize string + + tags string + tagsNE string + + hasAttributes string + lacksAttributes string + + hasMasks string + lacksMasks string + + hasLatents string + lacksLatents string +} + +// --- Sample data structures - these will be exposed to the Python world --------------------------------------------------------------------------------------------------------------------------------------------------------------- +type LatentPayload struct { + Data []byte + Len int + DataPtr uintptr +} + +type ImagePayload struct { + Data []byte + OriginalHeight int // Good indicator of the image frequency response at the current resolution + OriginalWidth int + Height int // Useful to decode the current payload + Width int + Channels int + DataPtr uintptr +} + +type Sample struct { + ID string + Source string + Attributes map[string]interface{} + Image ImagePayload + Masks map[string]ImagePayload + AdditionalImages map[string]ImagePayload + Latents map[string]LatentPayload + CocaEmbedding []float32 + Tags []string +} + +type URLPayload struct { + url string + content []byte +} + +// ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +// Public interface for this package, will be reflected in the python bindings + +type DataroomClient struct { + concurrency int + baseRequest http.Request + + context context.Context + waitGroup *sync.WaitGroup + cancel context.CancelFunc + + // Request parameters + sources string + require_images bool + require_embeddings bool + has_masks []string + has_latents []string + rank uint32 + world_size uint32 + + // Online transform parameters + crop_and_resize bool + default_image_size int + downsampling_ratio int + min_aspect_ratio float64 + max_aspect_ratio float64 + pre_encode_images bool + + // Channels - these will be used to communicate between the background goroutines + chanPageResults chan Response + chanSampleMetadata chan SampleMetadata + chanSamples chan Sample +} + +type DataroomClientConfig struct { + Sources string + RequireImages bool + RequireEmbeddings bool + Tags string + TagsNE string + HasAttributes string + LacksAttributes string + HasMasks string + LacksMasks string + HasLatents string + LacksLatents string + CropAndResize bool + DefaultImageSize int + DownsamplingRatio int + MinAspectRatio float64 + MaxAspectRatio float64 + PreEncodeImages bool + Rank uint32 + WorldSize uint32 + PrefetchBufferSize int + SamplesBufferSize int + ConcurrentDownloads int + PageSize int +} + +// ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + +func GetDefaultConfig() DataroomClientConfig { + return DataroomClientConfig{ + Sources: "", + RequireImages: true, + RequireEmbeddings: false, + Tags: "", + TagsNE: "", + HasAttributes: "", + LacksAttributes: "", + HasMasks: "", + LacksMasks: "", + HasLatents: "", + LacksLatents: "", + CropAndResize: false, + DefaultImageSize: 512, + DownsamplingRatio: 16, + MinAspectRatio: 0.5, + MaxAspectRatio: 2.0, + PreEncodeImages: false, + Rank: 0, + WorldSize: 1, + PrefetchBufferSize: 8, + SamplesBufferSize: 8, + ConcurrentDownloads: 2, + PageSize: 1000, + } +} + +func (c *DataroomClientConfig) getPageRequest() PageRequest { + + fields := "attributes,image_direct_url" + if c.HasLatents != "" || c.HasMasks != "" { + fields += ",latents" + fmt.Println("Including some latents:", c.HasLatents, c.HasMasks) + } + + if c.Tags != "" { + fields += ",tags" + fmt.Println("Including some tags:", c.Tags) + } + + if c.HasLatents != "" { + fmt.Println("Including some attributes:", c.HasLatents) + } + + if c.RequireEmbeddings { + fields += ",coca_embedding" + fmt.Println("Including embeddings") + } + + // Report some config data + fmt.Println("Rank | World size:", c.Rank, c.WorldSize) + fmt.Println("Sources:", c.Sources, "| Fields:", fields) + + return PageRequest{ + fields: fields, + sources: sanitizeStr(&c.Sources), + pageSize: fmt.Sprintf("%d", c.PageSize), + tags: sanitizeStr(&c.Tags), + tagsNE: sanitizeStr(&c.TagsNE), + hasAttributes: sanitizeStr(&c.HasAttributes), + lacksAttributes: sanitizeStr(&c.LacksAttributes), + hasMasks: sanitizeStr(&c.HasMasks), + lacksMasks: sanitizeStr(&c.LacksMasks), + hasLatents: sanitizeStr(&c.HasLatents), + lacksLatents: sanitizeStr(&c.LacksLatents), + } +} + +// Create a new Dataroom Client +func GetClient(config DataroomClientConfig) *DataroomClient { + + api_key := os.Getenv("DATAROOM_API_KEY") + if api_key == "" { + log.Panic("DATAROOM_API_KEY is not set") + } + + api_url := os.Getenv("DATAROOM_API_URL") + if api_url == "" { + log.Panic("DATAROOM_API_URL is not set") + } + + fmt.Println("Dataroom API URL:", api_url) + fmt.Println("Dataroom API KEY last characters:", getLast5Chars(api_key)) + + // Define the query which will be the backbone of this DataroomClient instance + request := config.getPageRequest() + + client := &DataroomClient{ + concurrency: config.ConcurrentDownloads, + baseRequest: *getHTTPRequest(api_url, api_key, request), + chanPageResults: make(chan Response, 2), + chanSampleMetadata: make(chan SampleMetadata, config.PrefetchBufferSize), + chanSamples: make(chan Sample, config.SamplesBufferSize), + require_images: config.RequireImages, + require_embeddings: config.RequireEmbeddings, + has_masks: strings.Split(config.HasMasks, ","), + has_latents: strings.Split(config.HasLatents, ","), + crop_and_resize: config.CropAndResize, + default_image_size: config.DefaultImageSize, + downsampling_ratio: config.DownsamplingRatio, + min_aspect_ratio: config.MinAspectRatio, + max_aspect_ratio: config.MaxAspectRatio, + pre_encode_images: config.PreEncodeImages, + sources: config.Sources, + rank: config.Rank, + world_size: config.WorldSize, + context: nil, + cancel: nil, + waitGroup: nil, + } + + // Make sure that the client will be Stopped() upon destruction + runtime.SetFinalizer(client, func(r *DataroomClient) { + r.Stop() + }) + + return client +} + +// Start the background downloads, make it ready to serve samples. Will grow the memory and CPU footprint +func (c *DataroomClient) Start() { + if c.context == nil || c.cancel == nil { + // Get a context and a cancel function to stop the background goroutines and gracefully handle + // interruptions at during http round trips + c.context, c.cancel = context.WithCancel(context.Background()) + } + + debug.SetGCPercent(10) // Invoke GC 10x more often + + vips.LoggingSettings(func(domain string, level vips.LogLevel, msg string) { + fmt.Println(domain, level, msg) + }, vips.LogLevelWarning) + vips.Startup(nil) // Initialize the vips library, image processing backend + + // Report panics in the background goroutines + defer func() { + if r := recover(); r != nil { + log.Printf("Caught a panic: %v", r) + log.Printf("Stack trace: %s", debug.Stack()) + os.Exit(-1) + } + }() + + // Optionally crop and resize the images and masks on the fly + var arAwareTransform *ARAwareTransform = nil + + if c.crop_and_resize { + fmt.Println("Cropping and resizing images") + fmt.Println("Base image size | downsampling ratio | min | max:", c.default_image_size, c.downsampling_ratio, c.min_aspect_ratio, c.max_aspect_ratio) + arAwareTransform = newARAwareTransform(c.default_image_size, c.downsampling_ratio, c.min_aspect_ratio, c.max_aspect_ratio) + } + + if c.pre_encode_images { + fmt.Println("Pre-encoding images, we'll return serialized JPG and PNG bytes") + } + + // Collect the pages, metadata and items in the background. + var wg sync.WaitGroup + + // Start all goroutines and log them in a waitgroup + wg.Add(1) + go func() { + defer wg.Done() + c.collectPages() // Fetch pages from the DB in the background + }() + + wg.Add(1) + go func() { + defer wg.Done() + c.collectMetadata() // Dispatch the content of the pages to the items channel + }() + + wg.Add(1) + go func() { + defer wg.Done() + c.collectItems(arAwareTransform) // Fetch the payloads and and deserialize them + }() + + c.waitGroup = &wg +} + +// Get a deserialized sample from the client +func (c *DataroomClient) GetSample() Sample { + if c.cancel == nil { + fmt.Println("Dataroom client not started. Starting it on the first sample, this adds some initial latency") + fmt.Println("Please consider starting the client in anticipation by calling .Start()") + c.Start() + } + + if sample, ok := <-c.chanSamples; ok { + return sample + } + + return Sample{} +} + +// Stop the background downloads, will clear the memory and CPU footprint +func (c *DataroomClient) Stop() { + fmt.Println("Stopping the dataroom client") + + // Signal the coroutines that next round should be a stop + if c.cancel == nil { + return // Already stopped + } + c.cancel() + + // Clear the channels, in case a commit is blocking + go consumeChannel(c.chanPageResults) + go consumeChannel(c.chanSampleMetadata) + go consumeChannel(c.chanSamples) + + // Wait for all goroutines to finish + if c.waitGroup != nil { + c.waitGroup.Wait() + } + + fmt.Println("Dataroom client stopped") + c.cancel = nil + c.context = nil +} + +// ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- +// Coroutines which will be running in the background + +func (c *DataroomClient) collectPages() { + // Fetch pages from the API, and feed the results to the items channel + // This is meant to be run in a goroutine + http_client := http.Client{Timeout: 30 * time.Second} + max_retries := 10 + + fetch_new_page := func() (*Response, error) { + resp, err := http_client.Do(&c.baseRequest) + + if err != nil { + return nil, err + } + + if resp.StatusCode != 200 { + return nil, fmt.Errorf("error fetching page: %s", resp.Status) + } + + defer resp.Body.Close() + + body, err := io.ReadAll(resp.Body) + if err != nil { + // Renew the HTTP client, server closed the connection + http_client = http.Client{Timeout: 30 * time.Second} + return nil, fmt.Errorf("error reading response body - renewing HTTP client. %s", err) + } + + // Unmarshal JSON response + var data Response + if err = json.Unmarshal(body, &data); err != nil { + return nil, err + } + return &data, nil + } + + for { + select { + case <-c.context.Done(): + fmt.Println("Pages fetch goroutine wrapping up") + return + + default: + valid_page := false + + for i := 0; i < max_retries; i++ { + // Try to fetch a new page, could go wrong in many ways + data, err := fetch_new_page() + + if err != nil { + // Retry loop + log.Print("Error fetching page: ", err) + continue + } + + // Commit the possible results to the downstream goroutines + if len(data.SampleMetadata) > 0 { + c.chanPageResults <- *data + } + + // Check if there are more pages to fetch + if data.Next == "" { + fmt.Println("No more pages to fetch, wrapping up") + close(c.chanPageResults) + return + } + + // Else fetch the next page + authentication := c.baseRequest.Header.Get("Authorization") + nextURL, _ := http.NewRequest("GET", data.Next, nil) + nextURL.Header.Add("Authorization", authentication) + c.baseRequest = *nextURL + + // Break the loop on success, gives us the opportunity to check whether the context has closed + valid_page = true + break + } + + // Check if we consumed all the retries + if !valid_page { + fmt.Println("Too many errors fetching new pages, wrapping up") + close(c.chanPageResults) + return + } + } + } +} + +func (c *DataroomClient) collectMetadata() { + // Break down the page results and maintain a list of individual items to be downloaded + // This is meant to be run in a goroutine + + for { + select { + case <-c.context.Done(): + fmt.Println("Metadata fetch goroutine wrapping up") + close(c.chanSampleMetadata) + return + case page, open := <-c.chanPageResults: + if !open { + fmt.Println("No more metadata to fetch, wrapping up") + close(c.chanSampleMetadata) + return + } + + for _, item := range page.SampleMetadata { + // Skip the sample if multi-rank is enabled and the rank is not the one we're interested in + if c.world_size > 1 && computeFNVHash32(item.Id)%c.world_size != c.rank { + continue + } + + select { + case <-c.context.Done(): + fmt.Println("Metadata fetch goroutine wrapping up") + close(c.chanSampleMetadata) + return + case c.chanSampleMetadata <- item: + // Item sent to the channel + } + } + } + } +} + +func (c *DataroomClient) collectItems(transform *ARAwareTransform) { + ack_channel := make(chan bool) + + sampleWorker := func(client *DataroomClient, transform *ARAwareTransform) { + // One HHTP client per goroutine, make sure we don't run into racing conditions when renewing + http_client := http.Client{Timeout: 30 * time.Second} + + for { + item_to_fetch, open := <-client.chanSampleMetadata + if !open { + ack_channel <- true + return + } + + sample := fetchSample(client, &http_client, item_to_fetch, transform) + if sample != nil { + client.chanSamples <- *sample + } + } + } + + // Start the workers and work on the metadata channel + for i := 0; i < c.concurrency; i++ { + go sampleWorker(c, transform) + } + + // Wait for all the workers to be done or overall context to be cancelled + for i := 0; i < c.concurrency; i++ { + <-ack_channel + } + close(c.chanSamples) + fmt.Println("No more items to serve, wrapping up") +} diff --git a/src/pkg/client/serdes.go b/src/pkg/client/serdes.go new file mode 100644 index 0000000..b082dc9 --- /dev/null +++ b/src/pkg/client/serdes.go @@ -0,0 +1,301 @@ +package datago + +import ( + "bytes" + "fmt" + "io" + "net/http" + "net/url" + "strings" + "time" + + "github.com/davidbyttow/govips/v2/vips" +) + +func readBodyBuffered(resp *http.Response) ([]byte, error) { + // Use a bytes.Buffer to accumulate the response body + // Faster than the default ioutil.ReadAll which reallocates + var body bytes.Buffer + + bufferSize := 2048 * 1024 // 2MB + + // Create a fixed-size buffer for reading + local_buffer := make([]byte, bufferSize) + + for { + n, err := resp.Body.Read(local_buffer) + if err != nil && err != io.EOF { + return nil, err + } + if n > 0 { + body.Write(local_buffer[:n]) + } + if err == io.EOF { + break + } + } + return body.Bytes(), nil +} + +func imageFromBuffer(buffer []byte, transform *ARAwareTransform, aspect_ratio float64, pre_encode_image bool, is_mask bool) (*ImagePayload, float64, error) { + // Decode the image payload using vips + img, err := vips.NewImageFromBuffer(buffer) + if err != nil { + return nil, -1., err + } + + err = img.AutoRotate() + if err != nil { + return nil, -1., err + } + + // Optionally crop and resize the image on the fly. Save the aspect ratio in the process for future use + original_width, original_height := img.Width(), img.Height() + + if transform != nil { + aspect_ratio, err = transform.cropAndResizeToClosestAspectRatio(img, aspect_ratio) + if err != nil { + return nil, -1., err + } + } + + width, height := img.Width(), img.Height() + + // If the image is 4 channels, we need to drop the alpha channel + if img.Bands() == 4 { + err = img.Flatten(&vips.Color{R: 255, G: 255, B: 255}) // Flatten with white background + if err != nil { + fmt.Println("Error flattening image:", err) + return nil, -1., err + } + fmt.Println("Image flattened") + } + + // If the image is not a mask but is 1 channel, we want to convert it to 3 channels + if (img.Bands() == 1) && !is_mask { + err = img.ToColorSpace(vips.InterpretationSRGB) + if err != nil { + fmt.Println("Error converting to sRGB:", err) + return nil, -1., err + } + } + + // If requested, re-encode the image to a jpg or png + var img_bytes []byte + var channels int + if pre_encode_image { + if err != nil { + return nil, -1., err + } + + if img.Bands() == 3 { + // Re-encode the image to a jpg + img_bytes, _, err = img.ExportJpeg(&vips.JpegExportParams{Quality: 95}) + if err != nil { + return nil, -1., err + } + } else { + // Re-encode the image to a png + img_bytes, _, err = img.ExportPng(vips.NewPngExportParams()) + if err != nil { + return nil, -1., err + } + } + channels = -1 // Signal that we have encoded the image + } else { + img_bytes, err = img.ToBytes() + if err != nil { + return nil, -1., err + } + channels = img.Bands() + } + + img_payload := ImagePayload{ + Data: img_bytes, + OriginalHeight: original_height, + OriginalWidth: original_width, + Height: height, + Width: width, + Channels: channels, + DataPtr: dataPtrFromSlice(img_bytes), + } + + return &img_payload, aspect_ratio, nil +} + +func fetchURL(client *http.Client, url string, retries int) (URLPayload, error) { + // Helper to fetch a binary payload from a URL + err_msg := "" + + for i := 0; i < retries; i++ { + resp, err := client.Get(url) + if err != nil { + if i == retries-1 { + err_msg = fmt.Sprintf("failed to fetch %s %s", url, err) + } + continue + } + defer resp.Body.Close() + + body_bytes, err := readBodyBuffered(resp) + if err != nil { + // Renew the http client, not a shared resource + client = &http.Client{Timeout: 30 * time.Second} + continue + } + + return URLPayload{url: url, content: body_bytes}, nil + } + + return URLPayload{url: url, content: nil}, fmt.Errorf(err_msg) +} + +func fetchImage(client *http.Client, url string, retries int, transform *ARAwareTransform, aspect_ratio float64, pre_encode_image bool, is_mask bool) (*ImagePayload, float64, error) { + err_report := fmt.Errorf("failed fetching image %s", url) + + for i := 0; i < retries; i++ { + // Get the raw image payload + resp, err := client.Get(url) + if err != nil { + err_report = err + + // Renew the client in case the connection was closed + client = &http.Client{Timeout: 30 * time.Second} + continue + } + defer resp.Body.Close() + + body_bytes, err := readBodyBuffered(resp) + if err != nil { + err_report = err + continue + } + + // Decode into a flat buffer using vips + img_payload_ptr, aspect_ratio, err := imageFromBuffer(body_bytes, transform, aspect_ratio, pre_encode_image, is_mask) + if err != nil { + break + } + return img_payload_ptr, aspect_ratio, nil + } + return nil, -1., err_report +} + +func fetchSample(client *DataroomClient, http_client *http.Client, sample_result SampleMetadata, transform *ARAwareTransform) *Sample { + // Per sample work: + // - fetch the raw payloads + // - deserialize / decode, depending on the types + // return the result to the samples channel + + retries := 5 + img_payload := &ImagePayload{} + + aspect_ratio := -1. // Not initialized to begin with + + // Base image + if client.require_images { + base_image, new_aspect_ratio, err := fetchImage(http_client, sample_result.ImageDirectURL, retries, transform, aspect_ratio, client.pre_encode_images, false) + + if err != nil { + fmt.Println("Error fetching image:", sample_result.Id) + return nil + } else { + img_payload = base_image + aspect_ratio = new_aspect_ratio + } + } + + // Latents + latents := make(map[string]LatentPayload) + masks := make(map[string]ImagePayload) + additional_images := make(map[string]ImagePayload) + + for _, latent := range sample_result.Latents { + if strings.Contains(latent.LatentType, "image") && !strings.Contains(latent.LatentType, "latent_") { + // Image types, registered as latents but they need to be jpg-decoded + new_image, _, err := fetchImage(http_client, latent.URL, retries, transform, aspect_ratio, client.pre_encode_images, false) + if err != nil { + fmt.Println("Error fetching masked image:", sample_result.Id, latent.LatentType) + return nil + } + + additional_images[latent.LatentType] = *new_image + } else if latent.IsMask { + // Mask types, registered as latents but they need to be png-decoded + mask_ptr, _, err := fetchImage(http_client, latent.URL, retries, transform, aspect_ratio, client.pre_encode_images, true) + if err != nil { + fmt.Println("Error fetching mask:", sample_result.Id, latent.LatentType) + return nil + } + masks[latent.LatentType] = *mask_ptr + } else { + // Vanilla latents, pure binary payloads + latent_payload, err := fetchURL(http_client, latent.URL, retries) + if err != nil { + fmt.Println("Error fetching latent:", err) + return nil + } + + latents[latent.LatentType] = LatentPayload{ + latent_payload.content, + len(latent_payload.content), + dataPtrFromSlice(latent_payload.content), + } + } + } + + // Optional embeddings + var cocaEmbedding []float32 + if client.require_embeddings { + cocaEmbedding = sample_result.CocaEmbedding.Vector + } + + return &Sample{ID: sample_result.Id, + Source: client.sources, + Attributes: sample_result.Attributes, + Image: *img_payload, + Latents: latents, + Masks: masks, + AdditionalImages: additional_images, + Tags: sample_result.Tags, + CocaEmbedding: cocaEmbedding} +} + +func getHTTPRequest(api_url string, api_key string, request PageRequest) *http.Request { + request_url, _ := http.NewRequest("GET", api_url+"images/", nil) + request_url.Header.Add("Authorization", "Token "+api_key) + req := request_url.URL.Query() + + maybeAddField := func(req *url.Values, field string, value string) { + if value != "" { + req.Add(field, value) + } + } + + // Limit the returned latents to the ones we asked for + return_latents := request.hasLatents + if request.hasMasks != "" { + return_latents += "," + request.hasMasks + } + + maybeAddField(&req, "fields", request.fields) + maybeAddField(&req, "source", request.sources) + maybeAddField(&req, "page_size", request.pageSize) + + maybeAddField(&req, "tags", request.tags) + maybeAddField(&req, "tags__ne", request.tagsNE) + + maybeAddField(&req, "has_attributes", request.hasAttributes) + maybeAddField(&req, "lacks_attributes", request.lacksAttributes) + + maybeAddField(&req, "has_masks", request.hasMasks) + maybeAddField(&req, "lacks_masks", request.lacksMasks) + + maybeAddField(&req, "has_latents", request.hasLatents) + maybeAddField(&req, "lacks_latents", request.lacksLatents) + maybeAddField(&req, "return_latents", return_latents) + request_url.URL.RawQuery = req.Encode() + fmt.Println("Request URL:", request_url.URL.String()) + fmt.Println() + return request_url +} diff --git a/src/pkg/client/transforms.go b/src/pkg/client/transforms.go new file mode 100644 index 0000000..9f0d683 --- /dev/null +++ b/src/pkg/client/transforms.go @@ -0,0 +1,113 @@ +package datago + +import ( + "fmt" + "math" + + "github.com/davidbyttow/govips/v2/vips" +) + +type ImageSize struct { + // Making it explicit how we store width and height, guarding against potential confusion + Width int + Height int +} + +func (s *ImageSize) AspectRatio() float64 { + // Specifying how we compute the aspect ratio explicitly, since height/width and width/height are both valid options + return float64(s.Width) / float64(s.Height) +} + +type ARAwareTransform struct { + defaultImageSize int + downsamplingRatio int + minAspectRatio float64 + maxAspectRatio float64 + targetImageSizes []ImageSize // list of [width, height] pairs + aspectRatioToSize map[float64]ImageSize +} + +func buildImageSizeList(defaultImageSize int, downsamplingRatio int, minAspectRatio float64, maxAspectRatio float64) []ImageSize { + patch_size := defaultImageSize / downsamplingRatio + patch_size_sq := float64(patch_size * patch_size) + var image_list []ImageSize + + min_patch_w := int(math.Ceil(patch_size_sq * minAspectRatio)) + max_patch_w := int(math.Floor(patch_size_sq * maxAspectRatio)) + + for patch_w := min_patch_w; patch_w <= max_patch_w; patch_w++ { // go over all possible downsampled image widths + patch_h := int(math.Floor(patch_size_sq / float64(patch_w))) // get max height + img_w, img_h := patch_w*downsamplingRatio, patch_h*downsamplingRatio + image_list = append(image_list, ImageSize{img_w, img_h}) + } + + min_patch_h := int(math.Ceil(math.Sqrt(patch_size_sq * 1.0 / maxAspectRatio))) + max_patch_h := int(math.Floor(math.Sqrt(patch_size_sq * 1.0 / minAspectRatio))) + for patch_h := min_patch_h; patch_h <= max_patch_h; patch_h++ { // go over all possible downsampled image heights + patch_w := int(math.Floor(patch_size_sq / float64(patch_h))) // get max width + img_w, img_h := patch_w*downsamplingRatio, patch_h*downsamplingRatio + image_list = append(image_list, ImageSize{img_w, img_h}) + } + + return image_list +} + +func newARAwareTransform(defaultImageSize int, downsamplingRatio int, minAspectRatio, maxAspectRatio float64) *ARAwareTransform { + // Build the image size list + image_list := buildImageSizeList(defaultImageSize, downsamplingRatio, minAspectRatio, maxAspectRatio) + + // Fill in the map table to match aspect ratios and image sizes + aspectRatioToSize := make(map[float64]ImageSize) + for _, size := range image_list { + aspectRatioToSize[size.AspectRatio()] = size + } + + // + return &ARAwareTransform{ + defaultImageSize: defaultImageSize, + downsamplingRatio: downsamplingRatio, + minAspectRatio: minAspectRatio, + maxAspectRatio: maxAspectRatio, + targetImageSizes: image_list, + aspectRatioToSize: aspectRatioToSize, + } +} + +func (t *ARAwareTransform) getClosestAspectRatio(imageWidth int, imageHeight int) float64 { + // Find the closest aspect ratio to the given aspect ratio + if len(t.aspectRatioToSize) == 0 { + fmt.Println("Aspect ratio to size map is empty") + panic("Aspect ratio to size map is empty") + } + + image_size := ImageSize{Width: imageWidth, Height: imageHeight} + aspectRatio := image_size.AspectRatio() + + // No choice but walking through all the possible values. Maybe possible to optimize this. in Go + minDiff := math.MaxFloat64 + closestAspectRatio := 0.0 + for ar := range t.aspectRatioToSize { + diff := math.Abs(ar - aspectRatio) + if diff < minDiff { + minDiff = diff + closestAspectRatio = ar + } + } + + return closestAspectRatio +} + +func (t *ARAwareTransform) cropAndResizeToClosestAspectRatio(image *vips.ImageRef, referenceAR float64) (float64, error) { + + // Get the closest aspect ratio + if referenceAR <= 0. { + referenceAR = t.getClosestAspectRatio(image.Width(), image.Height()) + } + + // Desired target size is a lookup away, this is pre-computed/bucketed + targetSize := t.aspectRatioToSize[referenceAR] + + // Trust libvips to do resize and crop in one go. Note that jpg decoding happens here and can fail + err := image.ThumbnailWithSize(targetSize.Width, targetSize.Height, vips.InterestingCentre, vips.SizeBoth) + return referenceAR, err +} diff --git a/src/pkg/client/utils.go b/src/pkg/client/utils.go new file mode 100644 index 0000000..98a5d47 --- /dev/null +++ b/src/pkg/client/utils.go @@ -0,0 +1,57 @@ +package datago + +import ( + "hash/fnv" + "time" + "unsafe" +) + +func computeFNVHash32(input string) uint32 { + // Create a new FNV-1a 32-bit hash + hasher := fnv.New32a() + + // Write data to the hash + hasher.Write([]byte(input)) + + // Compute the hash and return it as an integer + return hasher.Sum32() +} + +func dataPtrFromSlice(a []uint8) uintptr { + if len(a) == 0 { + return 0 + } + return uintptr(unsafe.Pointer(&a[0])) +} + +func exponentialBackoffWait(retries int) { + baseDelay := time.Second + maxDelay := 64 * time.Second + + // Calculate the delay with exponential backoff + delay := baseDelay * (1 << uint(retries)) + if delay > maxDelay { + delay = maxDelay + } + time.Sleep(delay) +} + +func getLast5Chars(s string) string { + runes := []rune(s) + if len(runes) <= 5 { + return s + } + return string(runes[len(runes)-5:]) +} + +func sanitizeStr(optional_str *string) string { + if optional_str == nil { + return "" + } + return *optional_str +} + +func consumeChannel[T any](ch <-chan T) { + for range ch { + } +} diff --git a/src/polyglot.py b/src/polyglot.py new file mode 100644 index 0000000..98202d3 --- /dev/null +++ b/src/polyglot.py @@ -0,0 +1,66 @@ +import ctypes +from PIL import Image +import io +from typing import Optional +import numpy as np + + +def uint8_array_to_numpy(go_array): + if go_array.DataPtr == 0: + print("Error: null pointer") + return np.array([], dtype=np.uint8) + + # By convention, arrays which are already serialized as jpg or png are not reshaped + # We export them from Go with a Channels dimension of -1 to mark them as dimensionless. + # Anything else is a valid number of channels and will thus lead to a reshape + num_final_channels = max(go_array.Channels, 1) + length = go_array.Width * go_array.Height * num_final_channels if go_array.Channels > 0 else len(go_array.Data) + shape = (go_array.Height, go_array.Width, go_array.Channels) if go_array.Channels > 0 else (length,) + + # Wrap the buffer around to create a numpy array. Strangely, shape needs to be passed twice + # This is a zero-copy operation + return np.ctypeslib.as_array((ctypes.c_uint8 * length).from_address(go_array.DataPtr), shape=shape).reshape(shape) + + +def go_array_to_numpy(go_array) -> Optional[np.ndarray]: + # Generic numpy-serialized array + + if go_array.DataPtr == 0: + # No data in the buffer + return None + + np_bytes = np.ctypeslib.as_array( + (ctypes.c_uint8 * go_array.Len).from_address(go_array.DataPtr), shape=(go_array.Len,) + ) + bytes_io = io.BytesIO(np_bytes.tobytes()) + try: + return np.load(bytes_io, allow_pickle=False) + except ValueError: + # Do not try to handle these, return None and we'll handle it in the caller + print("Could not deserialize numpy array") + return None + + +def go_array_to_pil_image(go_array): + # Zero copy conversion of the image buffer from Go to PIL.Image + + if go_array.DataPtr == 0: + # No data in the image buffer + return None + + np_array = uint8_array_to_numpy(go_array) + if go_array.Channels <= 0: + # Do not try to decode, we have a jpg or png buffer already + return np_array + + h, w, c = np_array.shape + + # Greyscale image + if c == 1: + return Image.fromarray(np_array[:, :, 0], mode="L") + + if c == 4: + return Image.frombuffer("RGBA", (w, h), np_array, "raw", "RGBA", 0, 1) + + assert c == 3, "Expected 3 channels" + return Image.fromarray(np_array) \ No newline at end of file diff --git a/src/tests/client_test.go b/src/tests/client_test.go new file mode 100644 index 0000000..7774cbf --- /dev/null +++ b/src/tests/client_test.go @@ -0,0 +1,221 @@ +package datago_test + +import ( + "os" + "testing" + + datago "datago/pkg/client" + + "github.com/davidbyttow/govips/v2/vips" +) + +func get_test_source() string { + return os.Getenv("DATAROOM_TEST_SOURCE") +} + +func TestClientStartStop(t *testing.T) { + config := datago.GetDefaultConfig() + config.Sources = get_test_source() + config.PageSize = 32 + + // Check that we can start, do nothing and stop the client immediately + client := datago.GetClient(config) + client.Start() + client.Stop() +} + +func TestClientNoStart(t *testing.T) { + config := datago.GetDefaultConfig() + config.Sources = get_test_source() + config.PageSize = 32 + + // Check that we can get a sample without starting the client + client := datago.GetClient(config) + sample := client.GetSample() + if sample.ID == "" { + t.Errorf("GetSample returned an unexpected error") + } +} + +func TestClientNoStop(t *testing.T) { + // Check that we can start, get a sample, and destroy the client immediately + // In that case Stop() should be called in the background, and everything should work just fine + config := datago.GetDefaultConfig() + config.Sources = get_test_source() + config.PageSize = 32 + config.SamplesBufferSize = 1 + + client := datago.GetClient(config) + client.Start() + _ = client.GetSample() + +} + +func TestMoreThanBufferSize(t *testing.T) { + // Check that we can start, get a sample, and destroy the client immediately + // In that case Stop() should be called in the background, and everything should work just fine + config := datago.GetDefaultConfig() + config.Sources = get_test_source() + config.PageSize = 32 + config.SamplesBufferSize = 1 + + client := datago.GetClient(config) + client.Start() + _ = client.GetSample() + + if client.GetSample().ID == "" { + t.Errorf("GetSample returned an unexpected error") + } +} + +func TestFetchImage(t *testing.T) { + config := datago.GetDefaultConfig() + config.Sources = get_test_source() + config.RequireImages = true + config.PageSize = 32 + config.SamplesBufferSize = 1 + + // Check that we can get an image + client := datago.GetClient(config) + sample := client.GetSample() + + // Assert that no error occurred + if sample.ID == "" { + t.Errorf("GetSample returned an unexpected error") + } + + // Assert that sample is not nil or has expected properties + if sample.Image.Height == 0 || sample.Image.Width == 0 { + t.Errorf("Expected non-nil sample") + } + + // Check the buffer size + if len(sample.Image.Data) != sample.Image.Height*sample.Image.Width*3 { + t.Errorf("Expected image buffer size to be Height*Width*3") + } + + client.Stop() +} + +func TestExtraFields(t *testing.T) { + config := datago.GetDefaultConfig() + config.Sources = get_test_source() + config.RequireImages = true + config.PageSize = 32 + config.HasLatents = "masked_image" + config.HasMasks = "segmentation_mask" + config.SamplesBufferSize = 1 + + // Check that we can get an image + client := datago.GetClient(config) + sample := client.GetSample() + + // Assert that no error occurred + if sample.ID == "" { + t.Errorf("GetSample returned an unexpected error") + } + + // Assert that we have the expected fields in the sample + if _, exists := sample.AdditionalImages["masked_image"]; !exists { + + t.Errorf("Sample is missing the required field %s", "masked_image") + } + + if _, exists := sample.Masks["segmentation_mask"]; !exists { + t.Errorf("Sample is missing the required field %s", "segmentation_mask") + } + + client.Stop() +} + +func TestCropAndResize(t *testing.T) { + config := datago.GetDefaultConfig() + config.Sources = get_test_source() + config.RequireImages = true + config.PageSize = 32 + config.CropAndResize = true + + client := datago.GetClient(config) + client.Start() + + for i := 0; i < 10; i++ { + sample := client.GetSample() + + // Assert that no error occurred + if sample.ID == "" { + t.Errorf("GetSample returned an unexpected error") + } + + // Assert that sample is not nil or has expected properties + if sample.Image.Height == 0 || sample.Image.Width == 0 { + t.Errorf("Expected non-nil sample") + } + + // Assert that image and masks are cropped and resized + for k, v := range sample.Masks { + if v.Height != sample.Image.Height || v.Width != sample.Image.Width { + t.Errorf("Expected cropped and resized mask %s", k) + } + } + + for k, v := range sample.AdditionalImages { + if v.Height != sample.Image.Height || v.Width != sample.Image.Width { + t.Errorf("Expected cropped and resized image %s", k) + } + } + } + client.Stop() +} + +func TestImageBufferCompression(t *testing.T) { + // Check that the image buffer is compressed, and that we can decode it properly + config := datago.GetDefaultConfig() + config.Sources = get_test_source() + config.RequireImages = true + config.PageSize = 32 + config.CropAndResize = true + config.HasLatents = "masked_image" + config.HasMasks = "segmentation_mask" + config.PreEncodeImages = true + client := datago.GetClient(config) + sample := client.GetSample() + + // Check that no error occurred + if sample.ID == "" { + t.Errorf("GetSample returned an unexpected error") + } + + // Check that the image buffers are compressed, and we can decode them properly + // -- Test the base image + if sample.Image.Channels != -1 { + t.Errorf("Expected compressed image buffer") + } + + decoded_image, err := vips.NewImageFromBuffer(sample.Image.Data) + if err != nil { + t.Errorf("Error decoding image buffer") + } + if decoded_image.Width() != sample.Image.Width || decoded_image.Height() != sample.Image.Height { + t.Errorf("Decoded image has unexpected dimensions %d %d %d %d", decoded_image.Width(), decoded_image.Height(), sample.Image.Width, sample.Image.Height) + } + + // -- Test the additional images (will be png compressed) + if sample.AdditionalImages["masked_image"].Channels != -1 { + t.Errorf("Expected compressed masked image buffer") + } + + _, err = vips.NewImageFromBuffer(sample.AdditionalImages["masked_image"].Data) + if err != nil { + t.Errorf("Error decoding masked image buffer") + } + + // -- Test the masks (will be png compressed) + if sample.Masks["segmentation_mask"].Channels != -1 { + t.Errorf("Expected compressed mask buffer") + } + + _, err = vips.NewImageFromBuffer(sample.Masks["segmentation_mask"].Data) + if err != nil { + t.Errorf("Error decoding mask buffer") + } +}