Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding tt-metalium #28854

Open
wants to merge 41 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
aad8e55
Add first shot
blozano-tt Jan 17, 2025
88b02fd
Adjust
blozano-tt Jan 17, 2025
4cbe34f
Progress
blozano-tt Jan 18, 2025
43ca25a
dunno
blozano-tt Jan 22, 2025
6fb0f13
dunno
blozano-tt Jan 22, 2025
d0dada2
Fix
blozano-tt Jan 22, 2025
b935312
Add libmpc as a dependency for sfpi
blozano-tt Jan 22, 2025
9bcf248
Try LD_LIBRARY_PATH
blozano-tt Jan 22, 2025
f7a7349
Try higher sysroot
blozano-tt Jan 22, 2025
605a5f8
Not sure
blozano-tt Jan 22, 2025
5d06a8c
Add missing dep zlib
blozano-tt Jan 22, 2025
8ccf7fc
Update to build and install python wheel
blozano-tt Jan 22, 2025
dc68535
Add python build deps
blozano-tt Jan 23, 2025
d1b88a2
Please
blozano-tt Jan 23, 2025
f522568
Reduce load on CPU
blozano-tt Jan 23, 2025
e858c4b
Try restricting python
blozano-tt Jan 23, 2025
2d3f737
Progress maybe
blozano-tt Jan 23, 2025
bbc7d92
Fix skip issue
blozano-tt Jan 23, 2025
04d3263
Fix python module installation hopefully
blozano-tt Jan 23, 2025
ff638a1
Merge branch 'main' into tt-metalium
blozano-tt Jan 23, 2025
8678be7
Hacks to fix python packaging maybe
blozano-tt Jan 24, 2025
293f3f7
Merge branch 'tt-metalium' of https://github.com/blozano-tt/staged-re…
blozano-tt Jan 24, 2025
65387d1
Merge branch 'main' into tt-metalium
jakirkham Jan 24, 2025
9842d1d
Update recipes/tt-metalium/meta.yaml
blozano-tt Jan 24, 2025
163f19b
Update recipes/tt-metalium/meta.yaml
blozano-tt Jan 24, 2025
2a3032d
Update meta.yaml
blozano-tt Jan 24, 2025
ed3b681
Add missing runtime deps for RISCV compiler binaries
blozano-tt Jan 24, 2025
3246ece
Use branch temporarily, relax other constraints
blozano-tt Jan 25, 2025
de4c472
Enable only python 3.10
blozano-tt Jan 26, 2025
9924066
Move back to tarball with latest code
blozano-tt Jan 29, 2025
37eb9c7
Update url logic
blozano-tt Jan 30, 2025
a5f7a46
Update recipes/tt-metalium/build.sh
blozano-tt Jan 30, 2025
4902999
Update recipes/tt-metalium/meta.yaml
blozano-tt Jan 30, 2025
29beb3e
Create multiple outputs to keep cpp sources seperate
blozano-tt Feb 1, 2025
f981c08
Update meta.yaml
blozano-tt Feb 1, 2025
60c4a31
Revert "Update meta.yaml"
blozano-tt Feb 1, 2025
e41eca4
Revert "Create multiple outputs to keep cpp sources seperate"
blozano-tt Feb 1, 2025
5d4b69b
Keep non python sources separate from site-packages
blozano-tt Feb 11, 2025
f10d051
Move extraneous files
blozano-tt Feb 12, 2025
7c57ba6
Update build.sh
blozano-tt Feb 12, 2025
f56c47f
Add license for sfpi
blozano-tt Feb 14, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
201 changes: 201 additions & 0 deletions recipes/third_party/sfpi/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,201 @@
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 2023 Tenstorrent Inc.

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.
46 changes: 46 additions & 0 deletions recipes/tt-metalium/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
#!/bin/env/bash
set -e

# Needed so that sfpi can be invoked at build time to generate object files
# sfpi links libmpc.so at runtime
export LD_LIBRARY_PATH=$PREFIX/lib

# Avoid overloading build machine processors and memory
export NUM_PROCS=$((CPU_COUNT / 2))

# Needed by python setup.py
export TT_FROM_PRECOMPILED_DIR=$SRC_DIR

cmake \
$CMAKE_ARGS \
-G Ninja \
-S $SRC_DIR \
-B $SRC_DIR/build \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_SKIP_INSTALL_RPATH=ON

cmake --build $SRC_DIR/build --parallel $NUM_PROCS

cmake --install $SRC_DIR/build

# Warning - HACK!
mkdir -p $SRC_DIR/build/lib
ln -sf $PREFIX/lib/_ttnn.so $SRC_DIR/build/lib/_ttnn.so

pip install --no-deps $SRC_DIR

#SFPI compiler binary and runtime loader files are brought in to site-packages
# via setup.py as of today
# This was not deemed as acceptable per conda-forge maintainer
# And its a reasonable objection
# Why is non python stuff in our python package?
# For now, keep it in a separate output directory and symlink it for functionality
mkdir -p $PREFIX/share/sfpi_runtime
mv $SP_DIR/runtime $PREFIX/share/sfpi_runtime
ln -sf $PREFIX/share/sfpi_runtime $SP_DIR/runtime

# Again, C++ kernel sources are copied into our site-packages directory
# Put them in a separate directory and symlink
mkdir -p $PREFIX/share/tt_metal
mv $SP_DIR/tt_metal $PREFIX/share/tt_metal
ln -sf $PREFIX/share/tt_metal $SP_DIR/tt_metal
4 changes: 4 additions & 0 deletions recipes/tt-metalium/conda_build_config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# This package uses some RISCV defines from the sysroot "elf.h"
# These defines are not available in the old sysroot
c_stdlib_version: # [linux]
- 2.34 # [linux]
blozano-tt marked this conversation as resolved.
Show resolved Hide resolved
75 changes: 75 additions & 0 deletions recipes/tt-metalium/meta.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
{% set name = "tt-metalium" %}
{% set version = "0.56.0.rc1" %}

package:
name: {{ name|lower }}
version: {{ version }}

source:
url: https://github.com/tenstorrent/tt-metal/releases/download/v{{ version.replace(".rc", "-rc") }}/tt-metalium.tar.gz
sha256: 319f8c8f5b3ce98ef7db0c0e230cd37aca339b06ece98d923daadf4d86b27465

# Skipping build for other python versions due to timeout in staging CI
# Will enable more python versions after merge
build:
number: 0
skip: true # [not linux or py!=310]
blozano-tt marked this conversation as resolved.
Show resolved Hide resolved

requirements:
build:
- {{ compiler('c') }}
- {{ compiler('cxx') }}
- {{ stdlib("c") }}
- cmake
- ninja
- git

host:
- python
- pip
- wheel
- setuptools
- numactl
- libhwloc
- mpc
- numpy
- loguru
- networkx
- pytorch
- python-graphviz

run:
- python
- numactl
- libhwloc
- libzlib
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Normally you shouldn't add libzlib at runtime, but put zlib into host. Your commit message in ed3b681 says "RISCV compiler binaries" - where are these coming from and how do they come into play?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/tenstorrent/tt-metal/blob/8b2c6cd16a27bd54675a018dc8a66013af3181e3/tt_metal/hw/CMakeLists.txt#L34

Released binaries are fetched At tt-metalium build time. They are used to compile some static riscv firmware.
They are used at runtime to jit compile kernel code that is later launched on riscv accelerators.

The compiler binaries are dynamically linking some things.

I realize after you highlight it, that this is not ideal for conda packaging.

Source is here:

https://github.com/tenstorrent/sfpi

I guess I could ask them to static link.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I’d like to avoid creating a conda package for that repo…

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Released binaries are fetched [at] build time. They are used to compile some static riscv firmware.
They are used at runtime to jit compile kernel code that is later launched on riscv accelerators.

Given that we don't have riscv support at the moment, I'd say this is probably alright for now, but still CC @conda-forge/core if someone has other opinions.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ping again for comments about whether and how we want to accept binary repackaging of cross-compilers for an architecture we don't support.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@isuruf they are all listed at the top of the README here: https://github.com/tenstorrent/sfpi

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You'll need to add all the license of the vendored packages here, both as the verbatim license file copied into the recipe, as well as referenced in the package metadata. Here's an example of what I mean: conda-forge/pytorch-cpu-feedstock@9a36bd4

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@h-vetinari Thanks for the example, I think this is done.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

GCC, Binutils, Newlib, Qemu and Dejagnu are (naturally) released under their own licenses.

I think there's more libraries still not covered. Also, CI is red. 🙃

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I put the license file in the wrong location… smh

- mpfr
- gmp
- mpc
- numpy
- loguru
- networkx
- pytorch
- python-graphviz

test:
imports:
- ttnn
blozano-tt marked this conversation as resolved.
Show resolved Hide resolved

about:
home: https://github.com/tenstorrent/tt-metal
summary: 'Simple, fast, extensible runtime libraries for Tenstorrent Hardware'
description: |
TT-NN operator library, and TT-Metalium low level kernel programming model.
license: Apache-2.0
license_family: Apache
license_file:
- LICENSE
- third_party/sfpi/LICENSE
doc_url: https://docs.tenstorrent.com/tt-metalium/latest
dev_url: https://github.com/tenstorrent/tt-metal

extra:
recipe-maintainers:
- blozano-tt
- afuller-TT
h-vetinari marked this conversation as resolved.
Show resolved Hide resolved
Loading