Skip to content

Commit cbc26ce

Browse files
committed
fix docs
1 parent 827d5c4 commit cbc26ce

File tree

2 files changed

+8
-10
lines changed

2 files changed

+8
-10
lines changed

README.md

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -112,17 +112,15 @@ For detailed examples and explanations see the [documentation](https://confopt.r
112112

113113
## 📚 Documentation
114114

115-
### **[Examples](https://confopt.readthedocs.io/en/latest/basic_usage.html)**
115+
### **User Guide**
116116
- **[Classification Example](https://confopt.readthedocs.io/en/latest/basic_usage/classification_example.html)**: RandomForest hyperparameter tuning on a classification task.
117117
- **[Regression Example](https://confopt.readthedocs.io/en/latest/basic_usage/regression_example.html)**: RandomForest hyperparameter tuning on a regression task.
118118

119-
### **[API Reference](https://confopt.readthedocs.io/en/latest/api_reference.html)**
119+
### **Developer Resources**
120+
- **[Architecture Overview](https://confopt.readthedocs.io/en/latest/architecture.html)**: System design and module interactions.
121+
- **[API Reference](https://confopt.readthedocs.io/en/latest/api_reference.html)**:
120122
Complete reference for main classes, methods, and parameters.
121123

122-
### **[Developer Resources](https://confopt.readthedocs.io/en/latest/architecture.html)**
123-
- **[Architecture Overview](https://confopt.readthedocs.io/en/latest/architecture.html)**: System design and component interactions.
124-
- **[Components Guide](https://confopt.readthedocs.io/en/latest/components.html)**: Deep dive into modules and mechanics.
125-
126124
## 🤝 Contributing
127125

128126
TBI
@@ -150,6 +148,5 @@ TBI
150148
<div align="center">
151149
<strong>Ready to take your hyperparameter optimization to the next level?</strong><br>
152150
<a href="https://confopt.readthedocs.io/en/latest/getting_started.html">Get Started</a> |
153-
<a href="https://confopt.readthedocs.io/en/latest/basic_usage.html">Examples</a> |
154151
<a href="https://confopt.readthedocs.io/en/latest/api_reference.html">API Docs</a> |
155152
</div>

docs/index.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
Hello! 👨‍🔬
2-
=========
1+
Overview
2+
========
33

4-
ConfOpt is a Python library for hyperparameter optimization using conformal prediction. It provides a statistically principled approach to hyperparameter tuning that combines the efficiency of guided search with the reliability of uncertainty quantification.
4+
`ConfOpt <https://github.com/rick12000/confopt>`_ is a Python library for hyperparameter optimization leveraging conformal prediction.
5+
It blends the strenghts of quantile regression with the calibration of conformal prediction. Find out how to include it in your ML workflow below!
56

67
.. toctree::
78
:maxdepth: 1

0 commit comments

Comments
 (0)