README.md

---
license: cc-by-nc-4.0
extra_gated_prompt: "You agree to not use the model to conduct experiments that cause harm to human subjects."
extra_gated_fields:
  Company: text
  Country: country
  Specific date: date_picker
  I want to use this model for:
    type: select
    options: 
      - Research
      - Education
      - label: Other
        value: other
  I agree to use this model for non-commercial use ONLY: checkbox
---

# Accessing model weights
login to HuggingFace in the environment in which you wish to use this model. You can do this from python as follows:

```
from huggingface_hub import login
AUTH_TOKEN = '' #specify your authentication token
login(AUTH_TOKEN)
```

For more details on logging in and downloading models from huggingface, please read their [documentation](https://huggingface.co/docs/huggingface_hub/en/quick-start#authentication). After logging in, you can download the weights to a specified path using the following python script
```
from huggingface_hub import snapshot_download
snapshot_download(repo_id='spatkar94/HistoTMEv2', local_dir='local_dir')
```
This will save all pretrained model checkpoints to a folder named `checkpoints` under your specified local_dir. 


# License
Copyright (c) 2024, spatkar94

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

By downloading or otherwise receiving the SOFTWARE, RECIPIENT may 
use and/or redistribute the SOFTWARE, with or without modification, 
subject to RECIPIENT’s agreement to the following terms:

1. THE SOFTWARE SHALL NOT BE USED IN THE TREATMENT OR DIAGNOSIS 
OF HUMAN SUBJECTS AND/OR ANY COMMERCIAL PURPOSES.  RECIPIENT is responsible for 
compliance with all laws and regulations applicable to the use 
of the SOFTWARE.

2. The SOFTWARE that is distributed pursuant to this Agreement 
has been created by United States Government employees. In 
accordance with Title 17 of the United States Code, section 105, 
the SOFTWARE is not subject to copyright protection in the 
United States.  Other than copyright, all rights, title and 
interest in the SOFTWARE shall remain with the PROVIDER.   

3.	RECIPIENT agrees to acknowledge PROVIDER’s contribution and 
the name of the author of the SOFTWARE in all written publications 
containing any data or information regarding or resulting from use 
of the SOFTWARE. 

4.	THE SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED 
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT 
ARE DISCLAIMED. IN NO EVENT SHALL THE PROVIDER OR THE INDIVIDUAL DEVELOPERS 
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 
THE POSSIBILITY OF SUCH DAMAGE.  

5.	RECIPIENT agrees not to use any trademarks, service marks, trade names, 
logos or product names of NCI or NIH to endorse or promote products derived 
from the SOFTWARE without specific, prior and written permission.

6.	For sake of clarity, and not by way of limitation, RECIPIENT may add its 
own copyright statement to its modifications or derivative works of the SOFTWARE 
and may provide additional or different license terms and conditions in its 
sublicenses of modifications or derivative works of the SOFTWARE provided that 
RECIPIENT’s use, reproduction, and distribution of the SOFTWARE otherwise complies 
with the conditions stated in this Agreement. Whenever Recipient distributes or 
redistributes the SOFTWARE, a copy of this Agreement must be included with 
each copy of the SOFTWARE.