Stable Diffusion関連ツールをDockerにインストールしようとしたらハマった話

著者: Natsuki Takayama
作成日: 2024年03月27日(水) 00:00
最終更新日: 2024年03月27日(水) 13:30
カテゴリ: コンピュータビジョン

こんにちは.高山です.
最近の生成AI関連の盛り上がりはすごいですね (良くも悪くもですが).
高山もこのビッグウェーブに何とかついていこうと,chatGPT や Stable Diffusion を触ってみてるところです (使いこなしているとは言えないですが... (^^;)).

普段 Stable Diffusion 関連のツールは,Docker-Compose でパッケージ化されたサービス (例えば,ブラウザ経由で推論できるサービス学習できるサービス) を使用しています.
これはこれですごい便利なのですが,良く分からないエラーが出た時に追いづらいという点がありました.
(いえ,追おうと思えば追えるのですが,パッケージ化されている時点で追う気にならないというのが正解かもしれません(^^;))

そこで,普段使っている Docker ベースの開発環境にツール郡を入れて,そこから動かせるように試みたところ,色々とハマりました(^^;).
今後同じようなことが起きたときのためのメモとしてやったことを書き残しておこうと思います.

なお,今回インストールしたツールは下記のとおりです.


1. 主なハマりどころ

今回は最終的にできあがった作業工程を紹介していきますので,下記に主なハマりどころを先に示しておきたいと思います.

  • Python3.10 の導入
  • Gradio のバージョン設定
  • 構成ファイルで指定されていない Python モジュールの設定

Python3.10 の導入

Stable Diffusion 関連のツールは Python3.10 で動作するように実装されています.
個人的に, Docker + virturalenv のように仮想環境を重ねるのはあまり好きではなく,Docker 単体で何とかしようとしたのが間違いの始まりでした(^^;).

Ubuntu20.04 では python3.8 がシステム標準でインストールされるのですが,update-alternative などを使うと,手動で入れた Python3.10 に切り替えることができます.
ただし他の依存モジュールはこの設定に従ってくれなく,依存モジュールを入れると設定が上書きされて元に戻ってしまうという現象が起きました.

最終的には,Python3.8 をシステム標準としたまま Python3.10 をインストールし,virtualenv で Python3.10 用の仮想環境を作成することで対処することにしました.

Gradio のバージョン設定

今回,Stable Diffusion web UI と Kohya's GUI というツールをインストールしたのですが,これらはそれぞれ違うバージョンの Gradio という GUI モジュールを使用しています.
片方のツールに Gradio のバージョンを合わせると,もう片方のツールが上手く動かないという状況で,原因・対処法の調査に苦労しました.

最終的には,Stable Diffusion web UI の設定に Gradio のバージョンをあわせて (v3.41.2),Kohya's GUI のバージョンを落とす (v23.0.11) ことで解決しています.

なお,Stable Diffusion web UI のソースコードを修正すれば,Gradio のバージョンを Kohya's GUI の設定 (v3.50.2) に合わせることが可能です.
こちらの対処法については,別記事で紹介したいと思います.

構成ファイルで指定されていない Python モジュールの設定

Python モジュールのインストールに際して,各ツールの構成ファイル (requirements.txt など) を参考にしたのですが,これらの構成ファイルだけではカバーされていないモジュールがいくつかあります.
カバーされていないモジュールは,各ツールの初期化処理で自動インストールされているようになっています.
ただし,初期化処理を起動するとインストール済みの Python モジュールが上書きされる恐れがあります.
結果として,一つずつ手動で対処していったため時間がかかってしまいました.

最終的には,カバーされていないモジュールを含むように自前の構成ファイルを用意することで解決しています.


2. ソースコード (Dockerfile 部分など) のライセンスについて

2.1 ベース Docker イメージ作成用コード

今回は GitHub じゃなくて記事内にソースコードを記述していますので,まずはライセンスについて表記しておきます.
第5節で紹介している,ベース Docker イメージ作成用コードは高山の作成物で,ライセンスは Apatch-2.0 です.
ライセンスに沿ってご利用いただく場合は特にご連絡等は必要ありません.

Apatch-2.0 のライセンス条項を下記に記します.

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!)  The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright [yyyy] [name of copyright owner]

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.

2.2 開発環境 Docker イメージ作成用コード

第6節で紹介している開発環境 Docker イメージ作成用コードは,JAremko 氏が公開している配布物を改変しています.
これらは GPL v3.0 ライセンスで配布されており,該当部分はオリジナルのライセンスを継承しておりますので,ご使用の際は注意してください.

GPL v3.0 のライセンス条項を下記に記します.

                    GNU GENERAL PUBLIC LICENSE
                       Version 3, 29 June 2007

 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
 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.

    {one line to give the program's name and a brief idea of what it does.}
    Copyright (C) {year}  {name of author}

    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 <http://www.gnu.org/licenses/>.

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:

    {project}  Copyright (C) {year}  {fullname}
    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
<http://www.gnu.org/licenses/>.

  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
<http://www.gnu.org/philosophy/why-not-lgpl.html>.

2.3 他の箇所について

他の箇所は基本的に,コマンドの実行やエラーの修正箇所を提示しているだけですのでライセンス等は特にありません.
ご自由にご利用ください (記事全体の著作権を放棄しているわけではありません).


3. PC の環境

今回インストールに使用した PC の環境は下記のとおりです.

  • ホストOS: Windows11 Pro, version 23H2, build no. 22631.3296
  • CPU: 12th Gen Intel(R) Core(TM) i5-12400 2.50 GHz
  • RAM: 64.0GB
  • GPU: NVIDIA GeForce RTX 3060 (12GB VRAM)
  • 仮想環境: WSL2, version 2.1.5.0
  • 仮想OS: Ubuntu20.04
  • Docker: Version 26.0.0, community edition

Docker は Windows 上にインストールする Docker デスクトップではなく,Ubuntu に直接インストールして使用しています.
なお,Windows,WSL および Docker のバージョンは今回のハマりどころには関係ありません.


4. 環境構築手順

図1に大まかな環境構築手順を示します.

図1: Stable Diffusion 用環境構築手順
Stable Diffusion 用環境構築手順

以降の節では図1の手順に沿って説明していきます.
作業は全て WSL2 上の Ubuntu20.04 内で行っています.


5. ベース Docker イメージの作成

まず最初に,ベースとなる Docker イメージを作成します.
Docker では下記に示すようなビルドスクリプトを用いて,開発やアプリケーションに必要な依存モジュールをインストールしていきます.
Docker について説明すると長くなってしまうので (ただでさえ長文を書きがちなのに...(^^;)),ご興味のある方は公式マニュアル等をご参照ください.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
# ========================================================================
# Build base image.
# ========================================================================
FROM nvidia/cuda:12.1.0-cudnn8-devel-ubuntu20.04 as sd_dev
# Setting nvidia-container-runtime
ENV NVIDIA_VISIBLE_DEVICES all
ENV NVIDIA_DRIVER_CAPABILITIES compute,utility,graphics,video,display
ENV NVIDIA_REQUIRE_CUDA "cuda>=12.0"

ENV NO_AT_BRIDGE=1
# Set DEBIAN_FRONTEND only during build.
# For the reason, please refer https://docs.docker.com/engine/faq/#why-is-debian_frontendnoninteractive-discouraged-in-dockerfiles
ARG DEBIAN_FRONTEND=noninteractive
WORKDIR /build

# =======================================================================
# Install basic staffs and dependencies.
# =======================================================================
RUN apt-get update -y && apt-get install -y --no-install-recommends \
    # basic staffs.
    git \
    wget \
    htop \
    curl \
    build-essential \
    pkg-config \
    cmake \
    # For cv2.
    libgl1-mesa-dev \
    # Tools.
    ffmpeg \
    python3-dev && \
    apt-get auto-remove && apt-get clean && rm -rf /tmp/* /var/lib/apt/lists/* /root/.cache/*

# ========================================================================
# Install Japanese environment.
# ========================================================================
RUN apt-get update -y && apt-get install -y --no-install-recommends \
    language-pack-ja && \
    apt-get auto-remove && apt-get clean && rm -rf /tmp/* /var/lib/apt/lists/* /root/.cache/*

# Workaround for UnicodeDecodeError.
# https://github.com/thisbejim/Pyrebase/issues/87
RUN update-locale LANG=ja_JP.UTF-8
ENV LANG="ja_JP.UTF-8" \
    LANGUAGE="ja_JP:ja" \
    LC_ALL="ja_JP.UTF-8"

# ========================================================================
# Python packages.
# ========================================================================

# Install latest pip.
RUN curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py && \
    python3 get-pip.py

RUN pip3 install virtualenv

# ========================================================================
# Install Python3.10 for stable diffusion.
# ========================================================================
RUN apt-key adv --keyserver keyserver.ubuntu.com --recv f23c5a6cf475977595c89f51ba6932366a755776
RUN { \
    echo "deb http://ppa.launchpad.net/deadsnakes/ppa/ubuntu focal main"; \
    echo "# deb-src http://ppa.launchpad.net/deadsnakes/ppa/ubuntu focal main"; \
    } > /etc/apt/sources.list.d/deadsnakes-ubuntu-ppa-bionic.list

ARG PYVERSION=3.10
RUN apt-get update -y && apt-get install -y --no-install-recommends \
    python${PYVERSION}-dev \
    python${PYVERSION}-distutils \
    python${PYVERSION}-tk && \
    apt-get auto-remove && apt-get clean && rm -rf /tmp/* /var/lib/apt/lists/* /root/.cache/*

# Clean up
RUN rm -rf /build
【コード解説】
- 4行目: GPUにアクセスする必要があるため,CUDAがインストール済みのUbuntu20.04をベースに設定
- 6-8行目: GPUの全機能が使えるように環境変数を設定
- 13行目: イメージのビルド中にインタラクティブな操作が入ると処理が停止してしまうので,
  インタラクティブ処理を停止
- 14行目: ソースコードのビルドが必要な場合に備えて,作業ディレクトリを設定
  (結果的に,今回は必要ありませんでした(^^;))
- 19-33行目: 開発時によく使うツールをまとめてインストール
  この中で必須のものは `git` と `python3-dev` です.
- 38-47行目: 日本語の表示や処理が必要な場合に備えて,日本語環境をインストール
- 54-55行目: Pythonのパッケージ管理ツールをインストール
- 57行目: Python用仮想環境構築ツール `virtualenv` をインストール
- 62-73行目: Python3.10をインストール
- 76行目: 作業ディレクトリを削除

Stable Diffusion 関連のツール郡は,Python3.10 向けに作られているものが多いです.
そのため,62-73行目で Python3.10 をインストールしています.
(Ubuntu22.04 の場合は Python3.10 が標準なのでこの工程は必要ありません)

ここで update-alternatives などで Python3.10 をシステム標準に設定すると,後の操作で設定を書き換えられてうまく行きませんので注意してください.
(正直なところ,ここでかなりハマりました(^^;))
今回はシステム標準は Python3.8 のままにしておいて,virtualenv で Python3.10 用の仮想環境を作成してその中でツールを動作させるようにします.

なお,Python 向けの仮想環境としては venv が標準で備わっていますが,こちらはシステム標準の Python でしか使えないので注意してください.
(依存モジュールは切り替えられるが,Python 自体は切り替えられません)

ビルドスクリプトが準備できたら,下記のコードで Docker イメージを作成します.

docker build -t sd_dev/base:ubuntu20.04 -f ./Dockerfile_base ./

6. 開発用の Docker イメージの作成 (Option)

ベースの Docker イメージができたら,それに重ねていく形で開発環境の Docker イメージを作成します.
基本的には高山の開発環境 (Emacs など) のインストールなので飛ばしていただいても構いません.

sudo やホストと同名のユーザでログインする設定も行っていますので,何か参考になれば幸いです.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
# ========================================================================
# Build development image.
# This script is based on
# https://github.com/JAremko/docker-emacs/blob/master/Dockerfile.emacs25.
#
# The author of the original script is JAremko.
# The original script is lisensed under the GNU General Public License v3.0,
# and this modified version also inherit this license.
# ========================================================================
# Use base build as parent image.

FROM sd_dev/base:ubuntu20.04

# Fix "Couldn't register with accessibility bus" error message
ENV NO_AT_BRIDGE=1
ARG DEBIAN_FRONTEND=noninteractive

# ========================================================================
# Install basic staff.
# ========================================================================
RUN apt-get update -y && apt-get install -y \
    dbus-x11 \
    fontconfig \
    gzip \
    language-pack-en-base \
    libgl1-mesa-glx \
    tar \
    unzip \
    bash \
    sudo \
    x11-apps \
    libcanberra-gtk* && \
# su-exec
    git clone https://github.com/ncopa/su-exec.git /tmp/su-exec && \
    cd /tmp/su-exec && \
    make && \
    chmod 770 su-exec && \
    mv ./su-exec /usr/local/sbin/ && \
# Cleanup
    apt-get autoremove -y && \
    rm -rf /tmp/* /var/lib/apt/lists/* /root/.cache/*

# ========================================================================
# Install python packages for development.
# ========================================================================
RUN pip3 install jedi==0.17.2 pylint flake8 autopep8 jupyter ipython mypy mkdocs icdiff keras-autodoc pycocotools

COPY entrypoint.sh /usr/local/sbin/

# Only for sudoers
RUN chown root /usr/local/sbin/entrypoint.sh && \
    chmod 700  /usr/local/sbin/entrypoint.sh

# ^^^^^^^ Those layers are shared ^^^^^^^

# Emacs
RUN apt-get update -y && apt-get install -y software-properties-common && \
    apt-add-repository -y ppa:kelleyk/emacs && \
    apt-get update -y && apt-get install -y emacs28 && \
# Cleanup
    apt-get purge -y software-properties-common && \
    rm -rf /tmp/* /var/lib/apt/lists/* /root/.cache/*

ENTRYPOINT ["entrypoint.sh"]
【コード解説】
- 12行目: ベースDockerイメージを基にビルドを行うことを指定
- 15行目: GTK (GUIツールキット) による警告を抑制する設定
- 16行目: イメージのビルド中にインタラクティブな操作が入ると処理が停止してしまうので,
  インタラクティブ処理を停止
- 21-41行目: 開発環境向けのパッケージをインストール.
  34-38行目で`sudo` を使用可能にする設定をしています.
- 46行目: 開発用Pythonモジュールをインストール
- 48-52行目: Dockerコンテナ立ち上げ時の実行コマンドを設定
- 57-62行目: Emacsインストール

最終行に出てきた entrypoint.sh は Docker コンテナを立ち上げた際に実行されるコマンドです.
下記に示すとおり,ホスト側のユーザ情報を読み取って,同名ユーザでコンテナに入るようにしています.
この処理によって,Docker 内で編集したファイルの権限がホスト側のユーザのものになります.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
#!/bin/bash

# ========================================================================
# This script is based on https://github.com/JAremko/docker-emacs/blob/master/asEnvUser.
#
# The author of the original script is JAremko.
# The original script is lisensed under the GNU General Public License v3.0,
# and this modified version also inherit this license.
# ========================================================================

## Create(if needed) this user and run command as the user:
# ENV UNAME="emacser" \
#     GNAME="emacs" \
#     UHOME="/home/emacs" \
#     UID="1000" \
#     GID="1000" \
#     WORKSPACE="/mnt/workspace" \
#     SHELL="/bin/bash"
## NOTE: ^^^^ Those are default values only in docker-emacs
## NOTE: The user will have "no password" sudo privilege

## Create user if it doesn't exists
if ! id "${UNAME}" >/dev/null 2>&1; then
        ## Prepend the user to /etc/passwd to ensure that it will
        ## override already existing users with the same IDs
        echo -e "${UNAME}:x:${UID}:${GID}:${UNAME},,,:${UHOME}:${SHELL}\n$(cat /etc/passwd)" > /etc/passwd
        echo "${UNAME}::17032:0:99999:7:::" >> /etc/shadow
fi

## Make sure that user is sudoer
if [ ! -f "/etc/sudoers.d/${UNAME}" ]; then
        echo "${UNAME} ALL=(ALL) NOPASSWD: ALL" > "/etc/sudoers.d/${UNAME}"
        chmod 0440 "/etc/sudoers.d/${UNAME}"
fi

## Create user's group if it doesn't exists
u_group=$(egrep -i "^${GNAME}" /etc/group)
if [ $? -ne 0 ]; then
        echo "${GNAME}:x:${GID}:${UNAME}" >> /etc/group
elif [[ ${u_group} != *"${UNAME}"* ]]; then
        sed -i -e "s/${u_group}/${u_group},${UNAME}/g" /etc/group
fi

## Make sure that the user owns home directory
if [ -d "${UHOME}" ]
then
        home_owner="$(stat -c '%U' ${UHOME})"
        if ! id "${home_owner}" >/dev/null 2>&1 || [ "$(id -u ${UNAME})" -ne "$(id -u ${home_owner})" ]; then
                chown "${UID}":"${GID}" -R ${UHOME}
        fi
else
        mkdir -p "${UHOME}"
        chown "${UID}":"${GID}" "${UHOME}"
fi

mkdir -p "${WORKSPACE}"
chown "${UID}":"${GID}" "${WORKSPACE}"
cd "${WORKSPACE}"

su-exec "${UNAME}" "$@"
【コード解説】
- 23-28行目: 同名ユーザ作成
- 30-34行目: ユーザが `sudo` を実行できるように設定
- 37-42行目: ユーザグループの作成
- 45-54行目: ホームディレクトリの作成
- 56-58行目: ホストととの共有ディレクトリを設定
- 60行目: ユーザに `sudo` 権限を与えてコマンドを実行 (通常は/bin/bashなど)

ビルドスクリプトが準備できたら,下記のコードで Docker イメージを作成します.

docker build -t sd_dev/dev:ubuntu20.04 -f ./Dockerfile_dev ./

ここまでの操作で開発環境の Docker イメージが作成できます.
コンテナを立ち上げる際は,下記のように entrypoint.sh が要求する引数を与えながら docker コマンドを実行します.

docker run --gpus all -it --rm --net host \
       --env UNAME=${USER} \
       --env UID=${UID} \
       --env GNAME=`id -g -n ${USER}` \
       --env GID=`id -g ${USER}` \
       --env UHOME=${HOME} \
       --env WORKSPACE=${HOME} \
       --enb SHELL="/bin/bash" \
       sd_dev/dev:ubuntu20.04 bash -l

実際の作業では,この後に一旦コンテナにログインして初期設定 (Emacs や Bash周り) を行い,その後 Docker イメージを更新しています (docker commit).
今回の話には関係の無い作業なので割愛させていただきます.


7. Git レポジトリのダウンロード

ここからは,ツールをインストールして動作させる作業に入っていきます.
まずは各ツールと依存モジュールのソースコードを GitHub のリポジトリからダウンロードします.

最初に,下記のコマンドでソースコード格納用ディレクトリを作成し,移動します.

mkdir sd_apps
cd sd_apps

次に,各リポジトリからソースコードをダウンロードします.
下記のコマンドで Stable Diffusion web UI に関連するソースコードをダウンロードします.

git clone https://github.com/salesforce/BLIP
git clone https://github.com/Stability-AI/generative-models
git clone https://github.com/crowsonkb/k-diffusion
git clone https://github.com/Stability-AI/stablediffusion
git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui

さらに,下記のコマンドで Kohya's GUI に関連するソースコードをダウンロードします.

git clone https://github.com/kohya-ss/sd-scripts
git clone https://github.com/bmaltais/kohya_ss -b v23.0.11

Kohya's GUI のバージョンを 23.0.11 に指定している点に注意してください.
冒頭で述べましたが,Kohya's GUI と Stable Diffusion web GUI は,Gradio という GUI モジュールに対してバージョンが競合しています.
ここでは,Stable Diffusion web GUI が指定するバージョン gradio==3.41.2 に合わせて Kohya's GUI のバージョンを設定しています.


8. Python環境の整備

8.1 Python仮想環境のインストール

次は Python 環境の整備を行います.
下記のコマンドで Python3.10 用の仮想環境を作成して起動します.

cd ~
python3 -m virtualenv -p python3.10 py310
source py310/bin/activate

以降の作業は,全て仮想環境内で行っています.


8.2 依存モジュールのインストール

Python 関連の依存モジュールをインストールします.
一個づつ pip コマンドでインストールするのは大変なので,構成ファイルにインストールするパッケージを記入し,一括でインストールします.

まずは構成ファイルを置くディレクトリを作成します.

mkdir requirements

各リポジトリから構成ファイルをコピーします.
次のコマンドでは,Stable Diffusion web UI 関連の構成ファイルをコピーしています.

cp sd_apps/BLIP/requirements.txt requirements/blip_dependencies.txt
cp sd_apps/generative-models/requirements/pt2.txt requirements/gmodel_dependencies.txt
cp sd_apps/k-diffusion/requirements.txt requirements/kd_dependencies.txt
cp sd_apps/stablediffusion/requirements.txt requirements/sd_dependencies.txt
cp sd_apps/stable-diffusion-webui/requirements.txt requirements/sdw_dependencies.txt

次のコマンドでは,Kohya's GUI 関連の構成ファイルをコピーしています.

cp sd_apps/sd-scripts/requirements.txt requirements/ss_dependencies.txt
cp sd_apps/kohya_ss/requirements.txt requirements/kss_dependencies.txt

各リポジトリの構成ファイルは個別に作成・管理されているので,バージョンがぶつかる可能性があります.
下記の方針で各ファイルを編集します.

  1. バージョン固定の設定は解除する (例えば numpy==1.26.0 -> numpy)
  2. バージョン固定が必須のモジュールは別ファイルに移動する
  3. 足りないモジュールは別ファイルに記入する

2番目と3番目の条件に該当するモジュールは下記のファイルに記入します.

vi ./requirements/base.txt

中身は次のようになっています.

# Common
gradio==3.41.2
pytorch-lightning==1.9.5
# For stable-diffusion-webui
pydantic==1.10.11
packbits
pytoshop==1.1.0
# For kohya-ss
bitsandbytes

上記の構成ファイル郡を呼び出す親構成ファイルを次のようにして作成します.

vi ./requirements.txt

中身は次のようになっています.

-r ./requirements/base.txt
-r ./requirements/blip_dependencies.txt
-r ./requirements/gmodel_dependencies.txt
-r ./requirements/kd_dependencies.txt
-r ./requirements/kss_dependencies.txt
-r ./requirements/ld_dependencies.txt
-r ./requirements/sd_dependencies.txt
-r ./requirements/sdw_dependencies.txt
-r ./requirements/ss_dependencies.txt

構成ファイルの準備ができましたので,次のコマンドでインストールします.

pip install -r ./requirements.txt

9. ツールのインストール

ここから先はツールのインストール作業を行います.
各ツールには初期設定を自動で行うスクリプトが用意されていますが,インストール済みの Python モジュールを書き換えてしまう恐れがあるため,ここでは手動でインストール作業を行います.


9.1 Stable Diffusion web UI のセットアップ

依存モジュールのパスを通す

まず最初に依存モジュールにパスを通します.
Stable Diffusion web UI では特定のディレクトリに依存モジュールのソースコードを配置することによってパス設定を行っています.

下記のコードで依存モジュールを配置するディレクトリを作成します.

cd sd_apps/steble-diffusion-webui
mkdir repositories
cd repositories

さらに,下記のコードでシンボリックファイルを作成し,HTML 関連の追加リポジトリをダウンロードします.

ln -s ../../BLIP
ln -s ../../generative-models
ln -s ../../k-diffusion
ln -s ../../stablediffusion/ stable-diffusion-stability-ai
git clone https://github.com/AUTOMATIC1111/stable-diffusion-webui-assets

以上で,パスの設定は完了です.

エラー箇所の修正

この時点で Stable Diffusion web UI は動作させることが可能ですが,起動すると下記のようなエラーが表示されます.

creating model quickly: OSError
Traceback (most recent call last):
  File "C:\stable-diffusion-webui\venv\lib\site-packages\huggingface_hub\utils\_errors.py", line 261, in hf_raise_for_status
    response.raise_for_status()
  File "C:\stable-diffusion-webui\venv\lib\site-packages\requests\models.py", line 1021, in raise_for_status
    raise HTTPError(http_error_msg, response=self)
requests.exceptions.HTTPError: 404 Client Error: Not Found for url: https://huggingface.co/None/resolve/main/config.json

このエラーは無視してもツールは動作しますが,気持ち悪いので下記のように修正を行います.

# Solve https://github.com/AUTOMATIC1111/stable-diffusion-webui/issues/13245
# modules/sd_disable_initialization.py
# Line 67-70
# def CLIPTextModel_from_pretrained(pretrained_model_name_or_path, *model_args, **kwargs):
#             res = self.CLIPTextModel_from_pretrained(None, *model_args, config=pretrained_model_name_or_path, state_dict={}, **kwargs)
#             res.name_or_path = pretrained_model_name_or_path
#             return res
def CLIPTextModel_from_pretrained(pretrained_model_name_or_path, *model_args, **kwargs):
            res = self.CLIPTextModel_from_pretrained(pretrained_model_name_or_path, *model_args, config=pretrained_model_name_or_path, state_dict={}, **kwargs)
            res.name_or_path = pretrained_model_name_or_path
            return re

なお上記のエラーは,モデルのロード停止を試みたところ,意図せず不正なURLからモデルのダウンロードをする動作となってしまいエラーとなっているようです.
上記のように,self.CLIPTextModel_from_pretrained() にパスを与えることでエラーは解消されます.

起動確認

それでは,下記のコマンドでツールを起動させてみます.

cd ~/sd_apps/stable-diffusion-webui
python3 webui.py
No module 'xformers'. Proceeding without it.
Loading weights [6ce0161689] from /home/takayaman/sd_apps_stable_gradio3412/stable-diffusion-webui/models/Stable-diffusion/v1-5-pruned-emaonly.safetensors
Running on local URL:  http://127.0.0.1:7860
Creating model from config: /home/takayaman/sd_apps_stable_gradio3412/stable-diffusion-webui/configs/v1-inference.yaml
Applying attention optimization: Doggettx... done.
Model loaded in 2.5s (load weights from disk: 0.5s, create model: 0.5s, apply weights to model: 1.1s, load textual inversion embeddings: 0.2s, calculate empty prompt: 0.1s).

To create a public link, set `share=True` in `launch()`.
Startup time: 7.0s (import torch: 2.4s, import gradio: 0.6s, setup paths: 0.9s, initialize shared: 0.1s, other imports: 0.2s, load scripts: 0.3s, create ui: 0.4s, gradio launch: 2.2s).

起動後はブラウザで localhost:7860 にアクセスするとツールが操作できます.
図2のような画面が表示されれば成功です.

図2: Stable Diffusion web UI の起動画面 (gradio v3.41.2使用時)
Stable Diffusion web UI の起動画面 (gradio v3.41.2使用時)

9.2 Kohya's GUI のセットアップ

依存モジュールのパスを通す

次に,Kohya's GUI の設定を行います.
こちらは簡単で,下記のように依存モジュールのパスを通せば良いです.

cd ~/sd_apps/kohya_ss
rmdir sd-scripts
ln -s ../sd-scripts

起動確認

それでは,下記のコマンドでツールを起動させてみます.

cd ~/sd_apps/kohya_ss
python3 kohya_gui.py
16:35:38-563399 INFO     headless: False
16:35:38-566199 INFO     Load CSS...
Running on local URL:  http://127.0.0.1:7860

To create a public link, set `share=True` in `launch()`.

起動後はブラウザで localhost:7860 にアクセスするとツールが操作できます.
図3のような画面が表示されれば成功です.

図3: Kohya's GUI (v23.0.11) の起動画面
Kohya's GUI (v23.0.11) の起動画面

今回は Stable Diffusion 関連ツールを Docker にインストールする手順を紹介しましたが,如何でしたでしょうか?
正直なところ,ここまで苦戦するとは思っていませんでした(^^;).
正直なところ,Stable Diffusion 関連のツールはメンテナンスが追いついていない印象を受けます.
これも急に注目を集めてプロジェクトが大きくなっていったことの副作用かもしれないですね.

何はともあれ,これで統一間のある環境でツール郡が動かせるようになってスッキリしました.
またツールを触っていく過程で面白いことが見つかれば記事にしていきたいと思います.

今回紹介した話が,これから生成AIを試してみようとお考えの方に何か参考になれば幸いです.