PyTorch documentation
- PyTorch Documentation Server Configuration
This document details the server configuration used to host the PyTorch documentation. It is intended for system administrators and engineers responsible for maintaining the documentation platform. This documentation is built using Sphinx, and hosted via nginx. Understanding these components is crucial for troubleshooting and scaling the documentation service.
== Overview
The PyTorch documentation is served from a cluster of servers, optimized for fast content delivery and high availability. The core components include content generation servers (where Sphinx builds the documentation), caching servers (using Varnish to reduce load on the content generation servers), and web servers (serving the static HTML files via nginx). A PostgreSQL database stores build metadata and version information. This setup aims to provide a seamless experience for users accessing the documentation.
== Hardware Specifications
The following table outlines the hardware specifications for each server type. These specifications are subject to change based on usage and performance monitoring.
| Server Type | CPU | Memory | Storage | Network |
|---|---|---|---|---|
| Content Generation | Intel Xeon Gold 6248R (24 cores) | 128 GB DDR4 ECC | 1 TB NVMe SSD | 10 Gbps |
| Caching | Intel Xeon Silver 4210 (10 cores) | 64 GB DDR4 ECC | 500 GB SSD | 10 Gbps |
| Web Server | Intel Xeon E-2224 (6 cores) | 32 GB DDR4 ECC | 250 GB SSD | 1 Gbps |
== Software Stack
The following software packages are essential for the PyTorch documentation server:
- Operating System: Ubuntu Server 22.04 LTS
- Web Server: nginx 1.25.3
- Reverse Proxy/Cache: Varnish 7.3.0
- Documentation Builder: Sphinx 5.1.1
- Programming Language: Python 3.10
- Database: PostgreSQL 14
- Version Control: Git
- Build Automation: Make
== Configuration Details
=== Nginx Configuration
Nginx acts as the primary web server and reverse proxy. The configuration is optimized for serving static content efficiently and forwarding requests to the caching layer. Key configuration directives include:
- `worker_processes`: Set to the number of CPU cores.
- `worker_connections`: Increased to handle concurrent requests.
- `gzip`: Enabled for compressing content.
- `proxy_cache_path`: Configured to use Varnish as the caching layer.
Here's a simplified excerpt of the nginx configuration:
```nginx http {
...
server {
listen 80;
server_name docs.pytorch.org;
location / {
proxy_pass http://varnish;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
}
}
...
} ```
=== Varnish Configuration
Varnish caches the static HTML files generated by Sphinx, reducing the load on the content generation servers. The Varnish configuration focuses on setting appropriate cache TTLs and defining purging strategies.
| Configuration Parameter | Value | Description |
|---|---|---|
| `storage.file_size` | 1GB | Maximum size of a cached object. |
| `cache_lifetime` | 7200s (2 hours) | Default TTL for cached objects. |
| `vcl_recv` | Custom VCL code for request handling. | |
| `vcl_backend_response` | Custom VCL code for response handling. |
=== Sphinx Configuration
Sphinx is responsible for building the documentation from reStructuredText source files. The `conf.py` file is the primary configuration file, controlling various aspects of the build process. Important configurations include:
- `extensions`: Specifies the Sphinx extensions to use (e.g., `sphinx.ext.autodoc`, `sphinx.ext.intersphinx`).
- `html_theme`: Sets the HTML theme for the documentation. We use a custom theme based on Read the Docs.
- `intersphinx_mapping`: Defines mappings to other documentation sets, enabling cross-referencing (e.g., Python documentation).
=== PostgreSQL Configuration
PostgreSQL stores metadata about documentation builds, including the version of PyTorch the documentation corresponds to, the build date, and the build status. This allows us to serve different versions of the documentation simultaneously.
| Parameter | Value | Description |
|---|---|---|
| `shared_buffers` | 128MB | Amount of memory dedicated to shared memory buffers. |
| `work_mem` | 32MB | Amount of memory used by internal sort operations. |
| `effective_cache_size` | 4GB | Estimated size of the operating system's disk cache. |
== Monitoring and Logging
Comprehensive monitoring and logging are essential for maintaining the health and performance of the documentation server. We use Prometheus and Grafana for monitoring key metrics, and ELK Stack (Elasticsearch, Logstash, Kibana) for log aggregation and analysis. Key metrics to monitor include:
- CPU utilization
- Memory usage
- Disk I/O
- Network traffic
- Nginx request latency
- Varnish cache hit ratio
- Sphinx build time
== Future Considerations
- Implementing a Content Delivery Network (CDN) to further improve performance for users around the world.
- Automating the documentation build and deployment process using CI/CD pipelines.
- Exploring the use of containerization (e.g., Docker) to simplify deployment and scaling.
- Investigating the use of more advanced caching strategies.
Special:Search/PyTorch Special:WhatLinksHere/PyTorch Help:Contents MediaWiki Server Administration Database Management Network Configuration Security Best Practices Troubleshooting Guide API documentation User Manual Installation Guide Contribution Guidelines Release Notes FAQ
Intel-Based Server Configurations
| Configuration | Specifications | Benchmark |
|---|---|---|
| Core i7-6700K/7700 Server | 64 GB DDR4, NVMe SSD 2 x 512 GB | CPU Benchmark: 8046 |
| Core i7-8700 Server | 64 GB DDR4, NVMe SSD 2x1 TB | CPU Benchmark: 13124 |
| Core i9-9900K Server | 128 GB DDR4, NVMe SSD 2 x 1 TB | CPU Benchmark: 49969 |
| Core i9-13900 Server (64GB) | 64 GB RAM, 2x2 TB NVMe SSD | |
| Core i9-13900 Server (128GB) | 128 GB RAM, 2x2 TB NVMe SSD | |
| Core i5-13500 Server (64GB) | 64 GB RAM, 2x500 GB NVMe SSD | |
| Core i5-13500 Server (128GB) | 128 GB RAM, 2x500 GB NVMe SSD | |
| Core i5-13500 Workstation | 64 GB DDR5 RAM, 2 NVMe SSD, NVIDIA RTX 4000 |
AMD-Based Server Configurations
| Configuration | Specifications | Benchmark |
|---|---|---|
| Ryzen 5 3600 Server | 64 GB RAM, 2x480 GB NVMe | CPU Benchmark: 17849 |
| Ryzen 7 7700 Server | 64 GB DDR5 RAM, 2x1 TB NVMe | CPU Benchmark: 35224 |
| Ryzen 9 5950X Server | 128 GB RAM, 2x4 TB NVMe | CPU Benchmark: 46045 |
| Ryzen 9 7950X Server | 128 GB DDR5 ECC, 2x2 TB NVMe | CPU Benchmark: 63561 |
| EPYC 7502P Server (128GB/1TB) | 128 GB RAM, 1 TB NVMe | CPU Benchmark: 48021 |
| EPYC 7502P Server (128GB/2TB) | 128 GB RAM, 2 TB NVMe | CPU Benchmark: 48021 |
| EPYC 7502P Server (128GB/4TB) | 128 GB RAM, 2x2 TB NVMe | CPU Benchmark: 48021 |
| EPYC 7502P Server (256GB/1TB) | 256 GB RAM, 1 TB NVMe | CPU Benchmark: 48021 |
| EPYC 7502P Server (256GB/4TB) | 256 GB RAM, 2x2 TB NVMe | CPU Benchmark: 48021 |
| EPYC 9454P Server | 256 GB RAM, 2x2 TB NVMe |
Order Your Dedicated Server
Configure and order your ideal server configuration
Need Assistance?
- Telegram: @powervps Servers at a discounted price
⚠️ *Note: All benchmark scores are approximate and may vary based on configuration. Server availability subject to stock.* ⚠️