Skip to content

Commit aeed36b

Browse files
Add absolute paths to images in readme so that pypi readme is rendered correctly
1 parent bb07f51 commit aeed36b

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img src="doc/_static/img/pyc_logo.png" alt="PyC Logo" width="40%">
2+
<img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/pyc_logo.png" alt="PyC Logo" width="40%">
33
</p>
44

55
<p align="center">
@@ -10,12 +10,12 @@
1010
</p>
1111

1212
<p align="center">
13-
<a href="https://pytorch-concepts.readthedocs.io/en/latest/guides/installation.html">🚀 Getting Started</a> -
14-
<a href="https://pytorch-concepts.readthedocs.io/">📚 Documentation</a> -
13+
<a href="https://pytorch-concepts.readthedocs.io/en/latest/guides/installation.html">🚀 Getting Started</a> -
14+
<a href="https://pytorch-concepts.readthedocs.io/">📚 Documentation</a> -
1515
<a href="https://pytorch-concepts.readthedocs.io/en/latest/guides/using.html">💻 User guide</a>
1616
</p>
1717

18-
<img src="doc/_static/img/logos/pyc.svg" width="20px" align="center"> PyC is a library built upon <img src="doc/_static/img/logos/pytorch.svg" width="20px" align="center"> PyTorch and <img src="doc/_static/img/logos/lightning.svg" width="20px" align="center"> Pytorch Lightning to easily implement **interpretable and causally transparent deep learning models**.
18+
<img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/pyc.svg" width="20px"> PyC is a library built upon <img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/pytorch.svg" width="20px" align="center"> PyTorch and <img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/lightning.svg" width="20px" align="center"> Pytorch Lightning to easily implement **interpretable and causally transparent deep learning models**.
1919
The library provides primitives for layers (encoders, predictors, special layers), probabilistic models, and APIs for running experiments at scale.
2020

2121
The name of the library stands for both
@@ -26,7 +26,7 @@ The name of the library stands for both
2626

2727
# Quick Start
2828

29-
You can install PyC with core dependencies from [PyPI](https://pypi.org/project/pytorch-concepts/):
29+
You can install <img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/pyc.svg" width="20px"> PyC with core dependencies from [PyPI](https://pypi.org/project/pytorch-concepts/):
3030

3131
```bash
3232
pip install pytorch-concepts
@@ -38,19 +38,19 @@ After installation, you can import it in your Python scripts as:
3838
import torch_concepts as pyc
3939
```
4040

41-
Follow our [user guide](https://pytorch-concepts.readthedocs.io/en/latest/guides/using.html) to get started with building interpretable models using PyC!
41+
Follow our [user guide](https://pytorch-concepts.readthedocs.io/en/latest/guides/using.html) to get started with building interpretable models using <img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/pyc.svg" width="20px"> PyC!
4242

4343
---
4444

45-
# <img src="doc/_static/img/logos/pyc.svg" width="20px" align="center"> PyC Software Stack
45+
# <img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/pyc.svg" width="20px"> PyC Software Stack
4646
The library is organized to be modular and accessible at different levels of abstraction:
47-
- <img src="doc/_static/img/logos/conceptarium.svg" width="20px" align="center"> **Conceptarium (No-code API). Use case: applications and benchmarking.** These APIs allow to easily run large-scale highly parallelized and standardized experiments by interfacing with configuration files. Built on top of <img src="doc/_static/img/logos/hydra-head.svg" width="20px" align="center"> Hydra and <img src="doc/_static/img/logos/wandb.svg" width="20px" align="center"> WandB.
48-
- **High-level APIs. Use case: use out-of-the-box state-of-the-art models.** These APIs allow to instantiate use implemented models with 1 line of code. This interface is built in <img src="doc/_static/img/logos/lightning.svg" width="20px" align="center"> Pytorch Lightning to easily standardize training and evaluation.
47+
- <img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/conceptarium.svg" width="20px" align="center"> **Conceptarium (No-code API). Use case: applications and benchmarking.** These APIs allow to easily run large-scale highly parallelized and standardized experiments by interfacing with configuration files. Built on top of <img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/hydra-head.svg" width="20px" align="center"> Hydra and <img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/wandb.svg" width="20px" align="center"> WandB.
48+
- **High-level APIs. Use case: use out-of-the-box state-of-the-art models.** These APIs allow to instantiate use implemented models with 1 line of code. This interface is built in <img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/lightning.svg" width="20px" align="center"> Pytorch Lightning to easily standardize training and evaluation.
4949
- **Mid-level APIs. Use case: build custom interpretable and causally transparent probabilistic graphical models.** These APIs allow to build new interpretable probabilistic models and run efficient tensorial probabilistic inference.
50-
- **Low-level APIs. Use case: assemble custom interpretable architectures.** These APIs allow to build architectures from basic interpretable layers in a plain <img src="doc/_static/img/logos/pytorch.svg" width="20px" align="center"> PyTorch-like interface. These APIs also include metrics, losses, and datasets.
50+
- **Low-level APIs. Use case: assemble custom interpretable architectures.** These APIs allow to build architectures from basic interpretable layers in a plain <img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/logos/pytorch.svg" width="20px" align="center"> PyTorch-like interface. These APIs also include metrics, losses, and datasets.
5151

5252
<p align="center">
53-
<img src="doc/_static/img/pyc_software_stack.png" alt="PyC Software Stack" width="90%">
53+
<img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/pyc_software_stack.png" alt="PyC Software Stack" width="90%">
5454
</p>
5555

5656
---
@@ -96,9 +96,10 @@ Reference authors: [Pietro Barbiero](http://www.pietrobarbiero.eu/), [Giovanni D
9696
This project is supported by the following organizations:
9797

9898
<p align="center">
99-
<img src="doc/_static/img/funding/fwo_kleur.png" alt="FWO - Research Foundation Flanders" height="60" style="margin: 20px;">
99+
<img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/funding/fwo_kleur.png" alt="FWO - Research Foundation Flanders" height="60" style="margin: 20px;">
100100
&nbsp;&nbsp;&nbsp;&nbsp;
101-
<img src="doc/_static/img/funding/hasler.png" alt="Hasler Foundation" height="60" style="margin: 20px;">
101+
<img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/funding/hasler.png" alt="Hasler Foundation" height="60" style="margin: 20px;">
102102
&nbsp;&nbsp;&nbsp;&nbsp;
103-
<img src="doc/_static/img/funding/snsf.png" alt="SNSF - Swiss National Science Foundation" height="60" style="margin: 20px;">
103+
<img src="https://raw.githubusercontent.com/pyc-team/pytorch_concepts/refs/heads/factors/doc/_static/img/funding/snsf.png" alt="SNSF - Swiss National Science Foundation" height="60" style="margin: 20px;">
104104
</p>
105+

0 commit comments

Comments
 (0)