Skip to content

Commit

Permalink
updates references to master with main
Browse files Browse the repository at this point in the history
  • Loading branch information
srhrshr committed Oct 15, 2020
1 parent 29b575d commit c48344f
Show file tree
Hide file tree
Showing 10 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion doc/config_rsmcompare.rst
Expand Up @@ -3,7 +3,7 @@
Experiment configuration file
"""""""""""""""""""""""""""""

This is a file in ``.json`` format that provides overall configuration options for an ``rsmcompare`` experiment. Here's an `example configuration file <https://github.com/EducationalTestingService/rsmtool/blob/master/examples/rsmcompare/config_rsmcompare.json>`_ for ``rsmcompare``.
This is a file in ``.json`` format that provides overall configuration options for an ``rsmcompare`` experiment. Here's an `example configuration file <https://github.com/EducationalTestingService/rsmtool/blob/main/examples/rsmcompare/config_rsmcompare.json>`_ for ``rsmcompare``.

.. note:: To make it easy to get started with ``rsmcompare``, we provide a way to **automatically generate** configurations file both interactively as well as non-interactively. Novice users will find interactive generation more helpful while more advanced users will prefer non-interactive generation. See :ref:`this page <autogen_configuration>` for more details.

Expand Down
2 changes: 1 addition & 1 deletion doc/config_rsmeval.rst
Expand Up @@ -3,7 +3,7 @@
Experiment configuration file
"""""""""""""""""""""""""""""

This is a file in ``.json`` format that provides overall configuration options for an ``rsmeval`` experiment. Here's an `example configuration file <https://github.com/EducationalTestingService/rsmtool/blob/master/examples/rsmeval/config_rsmeval.json>`_ for ``rsmeval``.
This is a file in ``.json`` format that provides overall configuration options for an ``rsmeval`` experiment. Here's an `example configuration file <https://github.com/EducationalTestingService/rsmtool/blob/main/examples/rsmeval/config_rsmeval.json>`_ for ``rsmeval``.

.. note:: To make it easy to get started with ``rsmeval``, we provide a way to **automatically generate** configurations file both interactively as well as non-interactively. Novice users will find interactive generation more helpful while more advanced users will prefer non-interactive generation. See :ref:`this page <autogen_configuration>` for more details.

Expand Down
2 changes: 1 addition & 1 deletion doc/config_rsmpredict.rst
Expand Up @@ -2,7 +2,7 @@

Experiment configuration file
"""""""""""""""""""""""""""""
This is a file in ``.json`` format that provides overall configuration options for an ``rsmpredict`` experiment. Here's an `example configuration file <https://github.com/EducationalTestingService/rsmtool/blob/master/examples/rsmpredict/config_rsmpredict.json>`_ for ``rsmpredict``.
This is a file in ``.json`` format that provides overall configuration options for an ``rsmpredict`` experiment. Here's an `example configuration file <https://github.com/EducationalTestingService/rsmtool/blob/main/examples/rsmpredict/config_rsmpredict.json>`_ for ``rsmpredict``.

.. note:: To make it easy to get started with ``rsmpredict``, we provide a way to **automatically generate** configurations file both interactively as well as non-interactively. Novice users will find interactive generation more helpful while more advanced users will prefer non-interactive generation. See :ref:`this page <autogen_configuration>` for more details.

Expand Down
2 changes: 1 addition & 1 deletion doc/config_rsmsummarize.rst
Expand Up @@ -3,7 +3,7 @@
Experiment configuration file
"""""""""""""""""""""""""""""

This is a file in ``.json`` format that provides overall configuration options for an ``rsmsummarize`` experiment. Here's an `example configuration file <https://github.com/EducationalTestingService/rsmtool/blob/master/examples/rsmsummarize/config_rsmsummarize.json>`_ for ``rsmsummarize``.
This is a file in ``.json`` format that provides overall configuration options for an ``rsmsummarize`` experiment. Here's an `example configuration file <https://github.com/EducationalTestingService/rsmtool/blob/main/examples/rsmsummarize/config_rsmsummarize.json>`_ for ``rsmsummarize``.

.. note:: To make it easy to get started with ``rsmsummarize``, we provide a way to **automatically generate** configurations file both interactively as well as non-interactively. Novice users will find interactive generation more helpful while more advanced users will prefer non-interactive generation. See :ref:`this page <autogen_configuration>` for more details.

Expand Down
2 changes: 1 addition & 1 deletion doc/config_rsmtool.rst
Expand Up @@ -3,7 +3,7 @@
Experiment configuration file
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

This is a file in ``.json`` format that provides overall configuration options for an ``rsmtool`` experiment. Here's an `example configuration file <https://github.com/EducationalTestingService/rsmtool/blob/master/examples/rsmtool/config_rsmtool.json>`_ for ``rsmtool``.
This is a file in ``.json`` format that provides overall configuration options for an ``rsmtool`` experiment. Here's an `example configuration file <https://github.com/EducationalTestingService/rsmtool/blob/main/examples/rsmtool/config_rsmtool.json>`_ for ``rsmtool``.

.. note:: To make it easy to get started with ``rsmtool``, we provide a way to **automatically generate** configurations file both interactively as well as non-interactively. Novice users will find interactive generation more helpful while more advanced users will prefer non-interactive generation. See :ref:`this page <autogen_configuration>` for more details.

Expand Down
2 changes: 1 addition & 1 deletion doc/contributing.rst
Expand Up @@ -8,7 +8,7 @@ Setting up

To set up a local development environment, follow the steps below:

1. Pull the latest version of RSMTool from GitHub and switch to the ``master`` branch.
1. Pull the latest version of RSMTool from GitHub and switch to the ``main`` branch.

2. If you already have the ``conda`` package manager installed, skip to the next step. If you do not, follow the instructions on `this page <https://conda.io/projects/conda/en/latest/user-guide/install/index.html>`_ to install conda.

Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
@@ -1,4 +1,4 @@
.. RSMTool documentation master file, created by
.. RSMTool documentation main file, created by
sphinx-quickstart on Mon Dec 11 10:52:16 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Expand Down
12 changes: 6 additions & 6 deletions doc/internal/release_process.rst
Expand Up @@ -3,7 +3,7 @@ RSMTool Release Process

This process is only meant for the project administrators, not users and developers.

1. Make sure any and all tests are passing in ``master``. Make sure you have also run tests locally in strict mode (``STRICT=1 nosetests --nologcapture tests``) to catch any deprecation warnings in the HTML report that can be fixed before the release.
1. Make sure any and all tests are passing in ``main``. Make sure you have also run tests locally in strict mode (``STRICT=1 nosetests --nologcapture tests``) to catch any deprecation warnings in the HTML report that can be fixed before the release.

2. Run the ``tests/update_files.py`` script with the appropriate arguments to make sure that all test data in the new release have correct experiment ids and filenames. If any (non-model) files need to be changed this should be investigated before the branch is released.

Expand Down Expand Up @@ -41,17 +41,17 @@ This process is only meant for the project administrators, not users and develop

12. Draft a release on GitHub while the Linux and Windows package tester builds are running.

13. Once both builds have passed, make a pull request with the release branch to be merged into ``master`` and request code review.
13. Once both builds have passed, make a pull request with the release branch to be merged into ``main`` and request code review.

14. Once the build for the PR passes and the reviewers approve, merge the release branch into ``master``.
14. Once the build for the PR passes and the reviewers approve, merge the release branch into ``main``.

15. Upload source and wheel packages to PyPI using ``python setup.py sdist upload`` and ``python setup.py bdist_wheel upload``

16. Make sure that the ReadTheDocs build for ``master`` passes by examining the badge at this `URL <https://img.shields.io/readthedocs/rsmtool/latest>`_ - this should say "passing" in green.
16. Make sure that the ReadTheDocs build for ``main`` passes by examining the badge at this `URL <https://img.shields.io/readthedocs/rsmtool/latest>`_ - this should say "passing" in green.

17. Tag the latest commit in ``master`` with the appropriate release tag and publish the release on GitHub.
17. Tag the latest commit in ``main`` with the appropriate release tag and publish the release on GitHub.

18. Make another PR to merge ``master`` branch into ``stable`` so that the the default ReadTheDocs build (which is ``stable``) always points to the latest release.
18. Make another PR to merge ``main`` branch into ``stable`` so that the the default ReadTheDocs build (which is ``stable``) always points to the latest release.

19. Update the CI plan for RSMExtra (only needed for ETS users) to use this newly built RSMTool conda package. Do any other requisite changes for RSMExtra. Once everything is done, do a release of RSMExtra.

Expand Down
2 changes: 1 addition & 1 deletion doc/pipeline.rst
Expand Up @@ -12,7 +12,7 @@ As its primary input, RSMTool takes a :ref:`data file <input_file_format>` conta

This trained model can then be used to generate scores for a held-out evaluation data whose feature values are pre-processed using the same :ref:`Pre-processing Parameters <preprocessing_parameters>`. In addition to the raw scores predicted by the model, the **Prediction Analysis** component of the pipline generates several additional :ref:`post-processed scores <score_postprocessing>` that are commonly used in automated scoring.

The primary output of RSMTool is a comprehensive, customizable HTML statistical report that contains the multiple analyses required for a comprehensive evaluation of an automated scoring model including descriptive analyses for all features, model analyses, subgroup comparisons, as well as several different :ref:`evaluation measures <evaluation>` illustrating model efficacy. More Details about these analyses can be found in this documentaion and in a separate `technical paper <https://raw.githubusercontent.com/EducationalTestingService/rsmtool/master/doc/assets/rsmtool.pdf>`_.
The primary output of RSMTool is a comprehensive, customizable HTML statistical report that contains the multiple analyses required for a comprehensive evaluation of an automated scoring model including descriptive analyses for all features, model analyses, subgroup comparisons, as well as several different :ref:`evaluation measures <evaluation>` illustrating model efficacy. More Details about these analyses can be found in this documentaion and in a separate `technical paper <https://raw.githubusercontent.com/EducationalTestingService/rsmtool/main/doc/assets/rsmtool.pdf>`_.

In addition to the HTML report, RSMTool also saves the intermediate outputs of all of the performed analyses as :ref:`CSV files <intermediate_files_rsmtool>`.

Expand Down
2 changes: 1 addition & 1 deletion doc/tutorial.rst
Expand Up @@ -26,7 +26,7 @@ ASAP Example

Let's see how we can apply this basic RSMTool workflow to a simple example based on a 2012 Kaggle competition on automated essay scoring called the `Automated Student Assessment Prize (ASAP) contest <https://www.kaggle.com/c/asap-aes>`_. As part of that contest, responses to 8 different essay questions written by students in grades 6-10 were provided. The responses were scored by humans and given a holistic score indicating the English proficiency of the student. The goal of the contest was to build an automated scoring model with the highest accuracy on held-out evaluation data.

For our tutorial, we will use one of the questions from this data to illustrate how to use RSMTool to train a scoring model and evaluate its performance. All of the data we refer to below can be found in the ``examples/rsmtool`` folder in the `github repository <https://github.com/EducationalTestingService/rsmtool/tree/master/examples/rsmtool>`_.
For our tutorial, we will use one of the questions from this data to illustrate how to use RSMTool to train a scoring model and evaluate its performance. All of the data we refer to below can be found in the ``examples/rsmtool`` folder in the `github repository <https://github.com/EducationalTestingService/rsmtool/tree/main/examples/rsmtool>`_.

Extract features
^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit c48344f

Please sign in to comment.