diff --git a/docs/apis/index.md b/docs/apis/index.md new file mode 100644 index 00000000..af02eee5 --- /dev/null +++ b/docs/apis/index.md @@ -0,0 +1,87 @@ +--- +icon: material/api +--- + +# OpenML APIs + +OpenML provides APIs for multiple programming languages and use cases. Choose your preferred client library to get started. + +## Client Libraries + +
+ +
+

Python

+

The OpenML Python API provides a convenient way to interact with OpenML from Python. It integrates with scikit-learn and other popular libraries.

+

Python Documentation →

+
+ +
+

R

+

The R client provides a native interface for R users, integrating with popular R machine learning libraries.

+

R Documentation →

+
+ +
+

Java

+

The Java client allows you to integrate OpenML into Java applications.

+

Java Documentation →

+
+ +
+

REST API

+

The REST API provides direct HTTP access to OpenML services. Use it from any programming language or tool.

+

REST API Documentation →

+
+ +
+ +## Additional Clients + +
+ +
+

PyTorch

+

OpenML integration for PyTorch workflows.

+

PyTorch Documentation →

+
+ +
+

TensorFlow

+

OpenML integration for TensorFlow workflows.

+

TensorFlow Documentation →

+
+ +
+

Julia

+

OpenML.jl - Julia client for OpenML.

+

Julia Documentation →

+
+ +
+

APIv2

+

The next generation OpenML API.

+

APIv2 Documentation →

+
+ +
+ +## Getting Started + +### Authentication + +To upload data or share experiments, you'll need an OpenML account and API key: + +1. [Create an account](https://www.openml.org/auth/sign-up) on OpenML.org +2. Go to your profile page to find your API key +3. Configure your client with the API key + +### Testing + +For development and testing, use the test server instead of the production server: + +- **Test server URL**: https://test.openml.org/ +- **Production server URL**: https://www.openml.org/ + +!!! note "Test Server" + The test server allows you to experiment without affecting production data. Use it for testing uploads, runs, and other operations. diff --git a/docs/css/extra.css b/docs/css/extra.css index f3c129b1..dd86b185 100644 --- a/docs/css/extra.css +++ b/docs/css/extra.css @@ -122,4 +122,32 @@ table { } .pink{ color: #4caf50 +} + +.grid-cards { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(280px, 1fr)); + gap: 20px; + margin: 20px 0; +} + +.grid-cards .card { + border: 1px solid var(--md-default-fg-color--lightest); + border-radius: 8px; + padding: 24px; + box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1); + transition: box-shadow 0.3s ease; +} + +.grid-cards .card:hover { + box-shadow: 0 4px 12px rgba(0, 0, 0, 0.15); +} + +.grid-cards .card h3 { + margin-top: 0; + color: var(--md-primary-fg-color); +} + +.grid-cards .card a { + font-weight: 600; } \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index f13d3b3a..0a462351 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -197,9 +197,10 @@ nav: - Style guide : contributing/Style.md - Resources: contributing/resources.md - Questions: help/index.md + - APIs: apis/index.md - Python: - python/index.md - - Code Reference: reference/ + - Code Reference: python/reference/ - Examples: examples/ - Usage: python/usage.md - Contributing: python/contributing.md