Merge pull request #672 from EducationalTestingService/various-docs-i…

…ssues Various minor fixes
EducationalTestingService · Feb 24, 2021 · 43bbcda · 43bbcda
2 parents 13aa5a7 + a692831
commit 43bbcda
Show file tree

Hide file tree

Showing 9 changed files with 42 additions and 9 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -0,0 +1,20 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.7
+  install:
+    - requirements: doc/requirements.txt
+  system_packages: true
diff --git a/.travis.yml b/.travis.yml
@@ -31,7 +31,6 @@ before_install:
   - ${HOME}/miniconda3/bin/conda update conda --yes
 install:
   - ${HOME}/miniconda3/bin/conda create --name sklldev -c conda-forge --file conda_requirements.txt python=${TRAVIS_PYTHON_VERSION} codecov --yes --quiet
-  - ${HOME}/miniconda3/envs/sklldev/bin/pip install nose-cov
   - ${HOME}/miniconda3/envs/sklldev/bin/pip install -e .
 
 # Run test

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -19,7 +19,7 @@ How to contribute
 
 3. Create an isolated environment for SKLL development. We recommend using the [conda](https://conda.io/en/latest/) package manager. To create a `conda` environment, run the following command in the root of the working directory:
 
-         $ conda create -n sklldev -c conda-forge nose --file conda_requirements.txt
+         $ conda create -n sklldev -c conda-forge --file conda_requirements.txt
 
 4. Activate the conda environment
 

diff --git a/README.rst b/README.rst
@@ -3,7 +3,11 @@ SciKit-Learn Laboratory
 
 .. image:: https://img.shields.io/travis/EducationalTestingService/skll/main.svg
    :alt: Build status
-   :target: https://travis-ci.org/EducationalTestingService/skll
+   :target: https://travis-ci.com/EducationalTestingService/skll
+
+.. image:: https://dev.azure.com/EducationalTestingService/SKLL/_apis/build/status/EducationalTestingService.skll
+   :target: https://dev.azure.com/EducationalTestingService/SKLL/_build?view=runs
+   :alt: Build status
 
 .. image:: https://codecov.io/gh/EducationalTestingService/skll/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/EducationalTestingService/skll
@@ -149,6 +153,10 @@ Talks
 -  *Simpler Machine Learning with SKLL 1.0*, Dan Blanchard, PyData NYC 2014 (`video <https://www.youtube.com/watch?v=VEo2shBuOrc&feature=youtu.be&t=1s>`__ | `slides <http://www.slideshare.net/DanielBlanchard2/py-data-nyc-2014>`__)
 -  *Simpler Machine Learning with SKLL*, Dan Blanchard, PyData NYC 2013 (`video <http://vimeo.com/79511496>`__ | `slides <http://www.slideshare.net/DanielBlanchard2/simple-machine-learning-with-skll>`__)
 
+Citing
+~~~~~~
+If you are using SKLL in your work, you can cite it as follows: "We used scikit-learn (Pedragosa et al, 2011) via the SKLL toolkit (https://github.com/EducationalTestingService/skll)."
+
 Books
 ~~~~~
 

diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -30,7 +30,7 @@ jobs:
     displayName: "Update conda"
 
   - script: |
-      conda create --name sklldev --yes --quiet -c conda-forge -c defaults python=%PYTHON_VERSION% nose --file conda_requirements.txt
+      conda create --name sklldev --yes --quiet -c conda-forge -c defaults python=%PYTHON_VERSION% --file conda_requirements.txt
       conda init cmd.exe
       CALL activate sklldev
       pip install -e .

diff --git a/conda_requirements.txt b/conda_requirements.txt
@@ -1,10 +1,11 @@
 beautifulsoup4
-joblib>=0.8
+joblib
 numpy
+nose-cov
 pandas
 pre-commit
 ruamel.yaml
-scikit-learn==0.24.1
+scikit-learn>=0.24.1,<=0.24.2
 scipy
 seaborn
 tabulate
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1,5 @@
+beautifulsoup4
+ruamel.yaml
+seaborn
+tabulate
+scikit-learn>=0.24.1,<=0.24.2
diff --git a/doc/run_experiment.rst b/doc/run_experiment.rst
@@ -1301,8 +1301,8 @@ predictions *(Optional)*
 """"""""""""""""""""""""
 
 Directory in which to store :ref:`prediction files <output_prediction_files>`.
-Can be omitted to not store predictions. Must *not* be specified for the
-:ref:`learning_curve <learning_curve>` and :ref:`train <train>` tasks.
+Must *not* be specified for the :ref:`learning_curve <learning_curve>` and
+:ref:`train <train>` tasks. If omitted, the current working directory is used.
 
 .. _probability:
 

diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,5 @@
 beautifulsoup4
-joblib>=0.8
+joblib
 numpy
 pandas
 ruamel.yaml