|
1 | | -# PyTorch Foundation Landscape |
| 1 | +# PyTorch Landscape |
2 | 2 |
|
3 | | - |
| 3 | + |
4 | 4 |
|
5 | | -- [PyTorch Landscape](#pytorch-foundation-landscape) |
6 | | - * [Interactive Version](#interactive-version) |
7 | | - * [New Entries](#new-entries) |
8 | | - * [Corrections and vulnerability-reporting](#Corrections-and-vulnerability-reporting) |
9 | | - * [Non-Updated Items](#non-updated-items) |
10 | | - * [License](#license) |
| 5 | +This landscape is intended as a map to explore open source projects and working groups hosted by PyTorch, open source projects in the energy and sustainability ecosystems, and also shows the PyTorch member companies. It is modeled after the Cloud Native Computing Foundation (CNCF) [landscape](https://landscape.cncf.io) and based on the same open-source code. |
11 | 6 |
|
12 | | -This landscape is intended as a map to explore the projects in the PyTorch Foundation Ecosystem. It is modeled after the Cloud Native Computing Foundation (CNCF) [landscape](https://landscape.cncf.io) and based on the same open source code. |
13 | | - |
14 | | -## Interactive Version |
15 | | - |
16 | | -Please see [landscape.pytorch.org](https://landscape.pytorch.org/) |
| 7 | +This repository contains the data files and images required to generate the [PyTorch landscape](https://landscape.pytorch.org). The software that generates it can be found at the [cncf/landscape2](https://github.com/cncf/landscape2) repository. Please see its [README file](https://github.com/cncf/landscape2#landscape2) for more information about how it works. |
17 | 8 |
|
18 | 9 | ## New Entries |
19 | 10 |
|
20 | | -* Projects must be open source and hosted on or mirrored to GitHub. |
21 | | -* If you would like your project to be considered to join the Ecosystem, submit a request to [Join the Ecosystem](https://pytorch.org/ecosystem/join) |
22 | | -* New projects are submitted to the PyTorch Ecosystem Working Group, a sub-group of the PyTorch Technical Advisory Council. If approved they will be added to the landscape by Foundation staff. |
23 | | -* Projects are placed in the category that best suits them. We are unlikely to create a new category for projects as we'd rather find the best home with the current options. |
24 | | -* All projects need a logo and the logo needs to include the name. Once approved, please plan to submit a logo for your project. If you need help with creating a logo, reach out the PyTorch Foundation team and they will assist you, by sending an email to support@pytorch.org. |
25 | | -* Crunchbase organization should be the company or organization that manages the project. |
26 | | - |
| 11 | +New entries to the landscape must be approved by the [PyTorch Ecosystem Working Group](https://github.com/pytorch-fdn/ecosystem). Projects wishing to become a PyTorch Ecosystem Project can apply [here](https://github.com/pytorch-fdn/ecosystem/issues/new). |
27 | 12 |
|
28 | | -## Corrections and vulnerability-reporting |
29 | | -* Please open an [issue](https://github.com/pytorch/landscape/issues/new) or, for sensitive information, email to support@pytorch.org. |
| 13 | +## Corrections |
30 | 14 |
|
31 | | -* If the error is with data from [Crunchbase](https://www.crunchbase.com/) you should open an account there and edit the data. If you don't like a project description, edit it in GitHub. If your project isn't showing the license correctly, you may need to paste the unmodified text of the license into a LICENSE file at the root of your project in GitHub, in order for GitHub to serve the license information correctly. |
| 15 | +Please open a pull request with edits to [landscape.yml](landscape.yml). |
32 | 16 |
|
33 | | -## External Data |
| 17 | +If the error is with data from [Crunchbase](https://www.crunchbase.com/) you should open an account there and edit the data. If you don't like a project description, edit it in GitHub. If your project isn't showing the license correctly, you may need to paste the unmodified text of the license into a LICENSE file at the root of your project in GitHub, in order for GitHub to serve the license information correctly. |
34 | 18 |
|
35 | | -The canonical source for all data is [landscape.yml](landscape.yml). Once a day, we download data for projects and companies from the following sources: |
| 19 | +### Updating PyTorch Members and Projects |
36 | 20 |
|
37 | | -* Project info from GitHub |
38 | | -* Funding info from [Crunchbase](https://www.crunchbase.com/) |
39 | | -* Market cap data from Yahoo Finance |
40 | | -* CII Best Practices Badge [data](https://bestpractices.coreinfrastructure.org/) |
| 21 | +PyTorch Member and Project data in this repository ( which in the [landscape.yml](landscape.yml) file are under categories `PyTorch Members` and `PyTorch Projects` ) are built nightly using the [LFX Landscape Tools](https://github.com/jmertic/lfx-landscape-tools). Any changes made directly in the data files in this repository for the above-referenced categories will be overwritten. |
41 | 22 |
|
42 | | -The update server enhances the source data with the fetched data and saves the result in [processed_landscape.yml](processed_landscape.yml). The app loads a JSON representation of processed_landscape.yml to display data. |
| 23 | +- For `PyTorch Members` entries, you can make these changes in [LFX Organization Dashboard](https://docs.linuxfoundation.org/lfx/organization-dashboard/organization-profile). |
| 24 | +- For `PyTorch Projects` entries, those changes can be made in [LFX Project Control Center (PCC)](https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/operations/project-definition). |
43 | 25 |
|
44 | | -## Non-Updated Items |
| 26 | +If you cannot access the above resources, please [create a helpdesk ticket](https://members.pytorch.org) to request those changes. |
45 | 27 |
|
46 | | -We generally archive open source projects that have not had a commit in over 1 year. Note that for projects not hosted on GitHub, we need them to mirror to GitHub to fetch updates, and we try to work with projects when their mirrors are broken. Here is view of projects sorted by last update: https://landscape.pytorch.io/grouping=no&license=open-source&sort=latest-commit |
| 28 | +## Local Build and Install |
47 | 29 |
|
48 | | -## License |
49 | | - |
50 | | -This repository contains data received from [Crunchbase](http://www.crunchbase.com). This data is not licensed pursuant to the Apache License. It is subject to Crunchbase’s Data Access Terms, available at [https://data.crunchbase.com/v3.1/docs/terms](https://data.crunchbase.com/v3.1/docs/terms), and is only permitted to be used with this Landscape Project which is hosted by the Linux Foundation. |
| 30 | +You can build the landscape locally on your machine using the [landscape2](https://github.com/cncf/landscape2) tool. Once [installed](https://github.com/cncf/landscape2?tab=readme-ov-file#installation), you can use the commands below to build the landscape and serve it locally. |
51 | 31 |
|
52 | | -Everything else is under the Apache License, Version 2.0, except for project and product logos, which are generally copyrighted by the company that created them, and are simply cached here for reliability. The trail map, static landscape, serverless landscape, and [landscape.yml](landscape.yml) file are alternatively available under the [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/). |
| 32 | +```shell |
| 33 | +landscape2 build --data-file landscape.yml --settings-url https://raw.githubusercontent.com/cncf/landscape2-sites/refs/heads/main/pytorch/settings.yml --logos-path hosted_logos --output-dir build |
| 34 | +landscape2 serve --landscape-dir build |
| 35 | +``` |
53 | 36 |
|
| 37 | +## License |
54 | 38 |
|
| 39 | +The generated landscape contains data received from [Crunchbase](http://www.crunchbase.com). This data is not licensed pursuant to the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt). It is subject to Crunchbase’s Data Access Terms, available at [https://data.crunchbase.com/docs/terms](https://data.crunchbase.com/docs/terms), and is only permitted to be used with PyTorch landscape projects. |
55 | 40 |
|
| 41 | +Everything else is under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt), except for projects and products logos, which are generally copyrighted by the company that created them, and are simply cached here for reliability. The generated landscape and the [landscape.yml](landscape.yml) file are alternatively available under the [Creative Commons Attribution 4.0 license](https://creativecommons.org/licenses/by/4.0/). |
0 commit comments