update docs

openml · Nov 14, 2024 · 441f03e · 441f03e
1 parent 1511e16
commit 441f03e
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 11 deletions.
diff --git a/docs/Examples/tf_image_classification.py b/docs/Examples/tf_image_classification.py
@@ -1,8 +1,8 @@
 """
-Tensorflow image classification model example
+Tensorflow image classification model example I
 ==================
 
-An example of a tensorflow network that classifies meta album images.
+An example of a Tensorflow network that classifies Meta Album images.
 """
 
 import openml

diff --git a/docs/Examples/tf_image_classification_Indoorscenes_dataset.py b/docs/Examples/tf_image_classification_Indoorscenes_dataset.py
@@ -1,5 +1,5 @@
 """
-Tensorflow big image dataset classification model example
+Tensorflow image dataset classification model example II
 ==================
 
 An example of a tensorflow network that classifies IndoorScenes images into `67` classes using tensorflow `Sequential` model.

diff --git a/docs/Examples/tf_pretrained_model_Indoorscenes_dataset.py b/docs/Examples/tf_pretrained_model_Indoorscenes_dataset.py
@@ -1,8 +1,9 @@
 """
-Tensorflow image classification model example
+Tensorflow image classification using pre-trained model example II
 ==================
 
-An example of a tensorflow network that classifies indoor scenes images using pre-trained transformer model.
+An example of a tensorflow network that classifies Indoor Scenes images using pre-trained transformer model.
+Here some layers of the pre-trained model are trained while other layers are frozen. 
 """
 
 

diff --git a/docs/Examples/tf_transfer_learning.py b/docs/Examples/tf_transfer_learning.py
@@ -1,5 +1,5 @@
 """
-Tensorflow image classification using pre-trained model example
+Tensorflow image classification using pre-trained model example I
 ==================
 
 An example of a tensorflow pre-trained network that classifies indoor scenes images, where all layers are trained. 

diff --git a/docs/Limitations of the API.md b/docs/Limitations of the API.md
@@ -0,0 +1,5 @@
+# Limitations
+
+- Image datasets are supported in OpenML as a workaround by using a CSV file with image paths. This is not ideal and might eventually be replaced by something else. At the moment, the focus is on tabular data.
+- OpenML-Tensorflow API currently only supports runs on image datasets. Other modalities will be included in the future.   
+- Many features (like custom metrics, models etc) are still dependant on the OpenML Python API, which is in the middle of a major rewrite. Until that is complete, this package will not be able to provide all the features it aims to.
diff --git a/docs/index.md b/docs/index.md
@@ -50,7 +50,7 @@ print('URL for run: %s/run/%d' % (openml.config.server, run.run_id))
 Note: The input layer of the network should be compatible with OpenML data output shape. Please check [examples](/docs/Examples/) for more information.
 
 
-Additionally, if you want to publish the run with onnx file, then you must call ```openml_pytorch.add_onnx_to_run()``` immediately before ```run.publish()```. 
+Additionally, if you want to publish the run with onnx file, then you must call ```openml_tensorflow.add_onnx_to_run()``` immediately before ```run.publish()```. 
 
 ```python
 run = openml_tensorflow.add_onnx_to_run(run)
@@ -59,7 +59,7 @@ run = openml_tensorflow.add_onnx_to_run(run)
 #### Using docker image
 
 The docker container has the latest version of [OpenML-Tensorflow](https://github.com/openml/openml-tensorflow) downloaded and pre-installed. It can be used to run TensorFlow Deep Learning analysis on OpenML datasets. 
-See [docker](docker/README.md).
+See [docker](/docs/Docker%20reference/Docker.md).
 
 
-This library is currently under development, please report any bugs or feature reuest in issues section.
+This library is currently under development, please report any bugs or feature request in issues section.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -63,5 +63,5 @@ nav:
     - "Image Classification Task on Big Dataset": "Examples/tf_image_classification_Indoorscenes_dataset.py"
     - "Pretrained Image Classification Example": "Examples/tf_pretrained_model_Indoorscenes_dataset.py"
     - "Pretrained Image Classification on Big Dataset": "Examples/tf_transfer_learning.py"
-  # - "Limitations of the API":  "Limitations of the API.md"
+  - "Limitations of the API":  "Limitations of the API.md"
 
diff --git a/openml_tensorflow/config.py b/openml_tensorflow/config.py
@@ -1,4 +1,7 @@
-# Config file to define all hyperparameters
+"""
+Config file to define all hyperparameters. 
+"""
+
 from tensorflow.keras.preprocessing.image import ImageDataGenerator
 
 epoch = 10